lib/command.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 require_once(INSTALLDIR.'/lib/channel.php');
  23
  24 class Command
  25 {
  26
  27     var $user = null;
  28
  29     function __construct($user=null)
  30     {
  31         $this->user = $user;
  32     }
  33
  34     function execute($channel)
  35     {
  36         return false;
  37     }
  38 }
  39
  40 class UnimplementedCommand extends Command
  41 {
  42     function execute($channel)
  43     {
  44         $channel->error($this->user, _("Sorry, this command is not yet implemented."));
  45     }
  46 }
  47
  48 class TrackingCommand extends UnimplementedCommand
  49 {
  50 }
  51
  52 class TrackOffCommand extends UnimplementedCommand
  53 {
  54 }
  55
  56 class TrackCommand extends UnimplementedCommand
  57 {
  58     var $word = null;
  59     function __construct($user, $word)
  60     {
  61         parent::__construct($user);
  62         $this->word = $word;
  63     }
  64 }
  65
  66 class UntrackCommand extends UnimplementedCommand
  67 {
  68     var $word = null;
  69     function __construct($user, $word)
  70     {
  71         parent::__construct($user);
  72         $this->word = $word;
  73     }
  74 }
  75
  76 class NudgeCommand extends Command
  77 {
  78     var $other = null;
  79     function __construct($user, $other)
  80     {
  81         parent::__construct($user);
  82         $this->other = $other;
  83     }
  84     function execute($channel)
  85     {
  86         $recipient = User::staticGet('nickname', $this->other);
  87         if(! $recipient){
  88             $channel->error($this->user, sprintf(_('Could not find a user with nickname %s.'),
  89                                $this->other));
  90         }else{
  91             if ($recipient->id == $this->user->id) {
  92                 $channel->error($this->user, _('It does not make a lot of sense to nudge yourself!'));
  93             }else{
  94                 if ($recipient->email && $recipient->emailnotifynudge) {
  95                     mail_notify_nudge($this->user, $recipient);
  96                 }
  97                 // XXX: notify by IM
  98                 // XXX: notify by SMS
  99                 $channel->output($this->user, sprintf(_('Nudge sent to %s.'),
 100                                $recipient->nickname));
 101             }
 102         }
 103     }
 104 }
 105
 106 class InviteCommand extends UnimplementedCommand
 107 {
 108     var $other = null;
 109     function __construct($user, $other)
 110     {
 111         parent::__construct($user);
 112         $this->other = $other;
 113     }
 114 }
 115
 116 class StatsCommand extends Command
 117 {
 118     function execute($channel)
 119     {
 120         $profile = $this->user->getProfile();
 121
 122         $subs_count   = $profile->subscriptionCount();
 123         $subbed_count = $profile->subscriberCount();
 124         $notice_count = $profile->noticeCount();
 125
 126         $channel->output($this->user, sprintf(_("Subscriptions: %1\$s\n".
 127                                    "Subscribers: %2\$s\n".
 128                                    "Notices: %3\$s"),
 129                                  $subs_count,
 130                                  $subbed_count,
 131                                  $notice_count));
 132     }
 133 }
 134
 135 class FavCommand extends Command
 136 {
 137     var $other = null;
 138
 139     function __construct($user, $other)
 140     {
 141         parent::__construct($user);
 142         $this->other = $other;
 143     }
 144
 145     function execute($channel)
 146     {
 147         if(substr($this->other,0,1)=='#'){
 148             //favoriting a specific notice_id
 149
 150             $notice = Notice::staticGet(substr($this->other,1));
 151             if (!$notice) {
 152                 $channel->error($this->user, _('Notice with that id does not exist.'));
 153                 return;
 154             }
 155             $recipient = $notice->getProfile();
 156         }else{
 157             //favoriting a given user's last notice
 158
 159             $recipient =
 160               common_relative_profile($this->user, common_canonical_nickname($this->other));
 161
 162             if (!$recipient) {
 163                 $channel->error($this->user, _('No such user.'));
 164                 return;
 165             }
 166             $notice = $recipient->getCurrentNotice();
 167             if (!$notice) {
 168                 $channel->error($this->user, _('User has no last notice.'));
 169                 return;
 170             }
 171         }
 172
 173         $fave = Fave::addNew($this->user, $notice);
 174
 175         if (!$fave) {
 176             $channel->error($this->user, _('Could not create favorite.'));
 177             return;
 178         }
 179
 180         $other = User::staticGet('id', $recipient->id);
 181
 182         if ($other && $other->id != $user->id) {
 183             if ($other->email && $other->emailnotifyfav) {
 184                 mail_notify_fave($other, $this->user, $notice);
 185             }
 186         }
 187
 188         $this->user->blowFavesCache();
 189
 190         $channel->output($this->user, _('Notice marked as fave.'));
 191     }
 192
 193 }
 194 class JoinCommand extends Command
 195 {
 196     var $other = null;
 197
 198     function __construct($user, $other)
 199     {
 200         parent::__construct($user);
 201         $this->other = $other;
 202     }
 203
 204     function execute($channel)
 205     {
 206
 207         $nickname = common_canonical_nickname($this->other);
 208         $group    = User_group::staticGet('nickname', $nickname);
 209         $cur      = $this->user;
 210
 211         if (!$group) {
 212             $channel->error($cur, _('No such group.'));
 213             return;
 214         }
 215
 216         if ($cur->isMember($group)) {
 217             $channel->error($cur, _('You are already a member of that group.'));
 218             return;
 219         }
 220         if (Group_block::isBlocked($group, $cur->getProfile())) {
 221           $channel->error($cur, _('You have been blocked from that group by the admin.'));
 222             return;
 223         }
 224
 225         $member = new Group_member();
 226
 227         $member->group_id   = $group->id;
 228         $member->profile_id = $cur->id;
 229         $member->created    = common_sql_now();
 230
 231         $result = $member->insert();
 232         if (!$result) {
 233           common_log_db_error($member, 'INSERT', __FILE__);
 234           $channel->error($cur, sprintf(_('Could not join user %1$s to group %2$s.'),
 235                                        $cur->nickname, $group->nickname));
 236           return;
 237         }
 238
 239         $channel->output($cur, sprintf(_('%1$s joined group %2$s'),
 240                                               $cur->nickname,
 241                                               $group->nickname));
 242     }
 243
 244 }
 245 class DropCommand extends Command
 246 {
 247     var $other = null;
 248
 249     function __construct($user, $other)
 250     {
 251         parent::__construct($user);
 252         $this->other = $other;
 253     }
 254
 255     function execute($channel)
 256     {
 257
 258         $nickname = common_canonical_nickname($this->other);
 259         $group    = User_group::staticGet('nickname', $nickname);
 260         $cur      = $this->user;
 261
 262         if (!$group) {
 263             $channel->error($cur, _('No such group.'));
 264             return;
 265         }
 266
 267         if (!$cur->isMember($group)) {
 268             $channel->error($cur, _('You are not a member of that group.'));
 269             return;
 270         }
 271
 272         $member = new Group_member();
 273
 274         $member->group_id   = $group->id;
 275         $member->profile_id = $cur->id;
 276
 277         if (!$member->find(true)) {
 278           $channel->error($cur,_('Could not find membership record.'));
 279           return;
 280         }
 281         $result = $member->delete();
 282         if (!$result) {
 283           common_log_db_error($member, 'INSERT', __FILE__);
 284           $channel->error($cur, sprintf(_('Could not remove user %1$s to group %2$s.'),
 285                                        $cur->nickname, $group->nickname));
 286           return;
 287         }
 288
 289         $channel->output($cur, sprintf(_('%1$s left group %2$s'),
 290                                               $cur->nickname,
 291                                               $group->nickname));
 292     }
 293
 294 }
 295
 296 class WhoisCommand extends Command
 297 {
 298     var $other = null;
 299     function __construct($user, $other)
 300     {
 301         parent::__construct($user);
 302         $this->other = $other;
 303     }
 304
 305     function execute($channel)
 306     {
 307         $recipient =
 308           common_relative_profile($this->user, common_canonical_nickname($this->other));
 309
 310         if (!$recipient) {
 311             $channel->error($this->user, _('No such user.'));
 312             return;
 313         }
 314
 315         $whois = sprintf(_("%1\$s (%2\$s)"), $recipient->nickname,
 316                          $recipient->profileurl);
 317         if ($recipient->fullname) {
 318             $whois .= "\n" . sprintf(_('Full name: %s'), $recipient->fullname);
 319         }
 320         if ($recipient->location) {
 321             $whois .= "\n" . sprintf(_('Location: %s'), $recipient->location);
 322         }
 323         if ($recipient->homepage) {
 324             $whois .= "\n" . sprintf(_('Homepage: %s'), $recipient->homepage);
 325         }
 326         if ($recipient->bio) {
 327             $whois .= "\n" . sprintf(_('About: %s'), $recipient->bio);
 328         }
 329         $channel->output($this->user, $whois);
 330     }
 331 }
 332
 333 class MessageCommand extends Command
 334 {
 335     var $other = null;
 336     var $text = null;
 337     function __construct($user, $other, $text)
 338     {
 339         parent::__construct($user);
 340         $this->other = $other;
 341         $this->text = $text;
 342     }
 343
 344     function execute($channel)
 345     {
 346         $other = User::staticGet('nickname', common_canonical_nickname($this->other));
 347
 348         $len = mb_strlen($this->text);
 349
 350         if ($len == 0) {
 351             $channel->error($this->user, _('No content!'));
 352             return;
 353         }
 354
 355         $this->text = common_shorten_links($this->text);
 356
 357         if (Message::contentTooLong($this->text)) {
 358             $channel->error($this->user, sprintf(_('Message too long - maximum is %1$d characters, you sent %2$d.'),
 359                                                  Message::maxContent(), mb_strlen($this->text)));
 360             return;
 361         }
 362
 363         if (!$other) {
 364             $channel->error($this->user, _('No such user.'));
 365             return;
 366         } else if (!$this->user->mutuallySubscribed($other)) {
 367             $channel->error($this->user, _('You can\'t send a message to this user.'));
 368             return;
 369         } else if ($this->user->id == $other->id) {
 370             $channel->error($this->user, _('Don\'t send a message to yourself; just say it to yourself quietly instead.'));
 371             return;
 372         }
 373         $message = Message::saveNew($this->user->id, $other->id, $this->text, $channel->source());
 374         if ($message) {
 375             $message->notify();
 376             $channel->output($this->user, sprintf(_('Direct message to %s sent.'), $this->other));
 377         } else {
 378             $channel->error($this->user, _('Error sending direct message.'));
 379         }
 380     }
 381 }
 382
 383 class RepeatCommand extends Command
 384 {
 385     var $other = null;
 386     function __construct($user, $other)
 387     {
 388         parent::__construct($user);
 389         $this->other = $other;
 390     }
 391
 392     function execute($channel)
 393     {
 394         if(substr($this->other,0,1)=='#'){
 395             //repeating a specific notice_id
 396
 397             $notice = Notice::staticGet(substr($this->other,1));
 398             if (!$notice) {
 399                 $channel->error($this->user, _('Notice with that id does not exist.'));
 400                 return;
 401             }
 402             $recipient = $notice->getProfile();
 403         }else{
 404             //repeating a given user's last notice
 405
 406             $recipient =
 407               common_relative_profile($this->user, common_canonical_nickname($this->other));
 408
 409             if (!$recipient) {
 410                 $channel->error($this->user, _('No such user.'));
 411                 return;
 412             }
 413             $notice = $recipient->getCurrentNotice();
 414             if (!$notice) {
 415                 $channel->error($this->user, _('User has no last notice.'));
 416                 return;
 417             }
 418         }
 419
 420         if($this->user->id == $notice->profile_id)
 421         {
 422             $channel->error($this->user, _('Cannot repeat your own notice.'));
 423             return;
 424         }
 425
 426         if ($recipient->hasRepeated($notice->id)) {
 427             $channel->error($this->user, _('Already repeated that notice.'));
 428             return;
 429         }
 430
 431         $repeat = $notice->repeat($this->user->id, $channel->source);
 432
 433         if ($repeat) {
 434             common_broadcast_notice($repeat);
 435             $channel->output($this->user, sprintf(_('Notice from %s repeated.'), $recipient->nickname));
 436         } else {
 437             $channel->error($this->user, _('Error repeating notice.'));
 438         }
 439     }
 440 }
 441
 442 class ReplyCommand extends Command
 443 {
 444     var $other = null;
 445     var $text = null;
 446     function __construct($user, $other, $text)
 447     {
 448         parent::__construct($user);
 449         $this->other = $other;
 450         $this->text = $text;
 451     }
 452
 453     function execute($channel)
 454     {
 455         if(substr($this->other,0,1)=='#'){
 456             //replying to a specific notice_id
 457
 458             $notice = Notice::staticGet(substr($this->other,1));
 459             if (!$notice) {
 460                 $channel->error($this->user, _('Notice with that id does not exist.'));
 461                 return;
 462             }
 463             $recipient = $notice->getProfile();
 464         }else{
 465             //replying to a given user's last notice
 466
 467             $recipient =
 468               common_relative_profile($this->user, common_canonical_nickname($this->other));
 469
 470             if (!$recipient) {
 471                 $channel->error($this->user, _('No such user.'));
 472                 return;
 473             }
 474             $notice = $recipient->getCurrentNotice();
 475             if (!$notice) {
 476                 $channel->error($this->user, _('User has no last notice.'));
 477                 return;
 478             }
 479         }
 480
 481         $len = mb_strlen($this->text);
 482
 483         if ($len == 0) {
 484             $channel->error($this->user, _('No content!'));
 485             return;
 486         }
 487
 488         $this->text = common_shorten_links($this->text);
 489
 490         if (Notice::contentTooLong($this->text)) {
 491             $channel->error($this->user, sprintf(_('Notice too long - maximum is %1$d characters, you sent %2$d.'),
 492                                                  Notice::maxContent(), mb_strlen($this->text)));
 493             return;
 494         }
 495
 496         $notice = Notice::saveNew($this->user->id, $this->text, $channel->source(),
 497                                   array('reply_to' => $notice->id));
 498
 499         if ($notice) {
 500             $channel->output($this->user, sprintf(_('Reply to %s sent.'), $recipient->nickname));
 501         } else {
 502             $channel->error($this->user, _('Error saving notice.'));
 503         }
 504         common_broadcast_notice($notice);
 505     }
 506 }
 507
 508 class GetCommand extends Command
 509 {
 510
 511     var $other = null;
 512
 513     function __construct($user, $other)
 514     {
 515         parent::__construct($user);
 516         $this->other = $other;
 517     }
 518
 519     function execute($channel)
 520     {
 521         $target_nickname = common_canonical_nickname($this->other);
 522
 523         $target =
 524           common_relative_profile($this->user, $target_nickname);
 525
 526         if (!$target) {
 527             $channel->error($this->user, _('No such user.'));
 528             return;
 529         }
 530         $notice = $target->getCurrentNotice();
 531         if (!$notice) {
 532             $channel->error($this->user, _('User has no last notice.'));
 533             return;
 534         }
 535         $notice_content = $notice->content;
 536
 537         $channel->output($this->user, $target_nickname . ": " . $notice_content);
 538     }
 539 }
 540
 541 class SubCommand extends Command
 542 {
 543
 544     var $other = null;
 545
 546     function __construct($user, $other)
 547     {
 548         parent::__construct($user);
 549         $this->other = $other;
 550     }
 551
 552     function execute($channel)
 553     {
 554
 555         if (!$this->other) {
 556             $channel->error($this->user, _('Specify the name of the user to subscribe to.'));
 557             return;
 558         }
 559
 560         $result = subs_subscribe_user($this->user, $this->other);
 561
 562         if ($result == 'true') {
 563             $channel->output($this->user, sprintf(_('Subscribed to %s'), $this->other));
 564         } else {
 565             $channel->error($this->user, $result);
 566         }
 567     }
 568 }
 569
 570 class UnsubCommand extends Command
 571 {
 572
 573     var $other = null;
 574
 575     function __construct($user, $other)
 576     {
 577         parent::__construct($user);
 578         $this->other = $other;
 579     }
 580
 581     function execute($channel)
 582     {
 583         if(!$this->other) {
 584             $channel->error($this->user, _('Specify the name of the user to unsubscribe from.'));
 585             return;
 586         }
 587
 588         $result=subs_unsubscribe_user($this->user, $this->other);
 589
 590         if ($result) {
 591             $channel->output($this->user, sprintf(_('Unsubscribed from %s'), $this->other));
 592         } else {
 593             $channel->error($this->user, $result);
 594         }
 595     }
 596 }
 597
 598 class OffCommand extends Command
 599 {
 600     var $other = null;
 601     function __construct($user, $other=null)
 602     {
 603         parent::__construct($user);
 604         $this->other = $other;
 605     }
 606     function execute($channel)
 607     {
 608         if ($other) {
 609             $channel->error($this->user, _("Command not yet implemented."));
 610         } else {
 611             if ($channel->off($this->user)) {
 612                 $channel->output($this->user, _('Notification off.'));
 613             } else {
 614                 $channel->error($this->user, _('Can\'t turn off notification.'));
 615             }
 616         }
 617     }
 618 }
 619
 620 class OnCommand extends Command
 621 {
 622     var $other = null;
 623     function __construct($user, $other=null)
 624     {
 625         parent::__construct($user);
 626         $this->other = $other;
 627     }
 628
 629     function execute($channel)
 630     {
 631         if ($other) {
 632             $channel->error($this->user, _("Command not yet implemented."));
 633         } else {
 634             if ($channel->on($this->user)) {
 635                 $channel->output($this->user, _('Notification on.'));
 636             } else {
 637                 $channel->error($this->user, _('Can\'t turn on notification.'));
 638             }
 639         }
 640     }
 641 }
 642
 643 class LoginCommand extends Command
 644 {
 645     function execute($channel)
 646     {
 647         $disabled = common_config('logincommand','disabled');
 648         $disabled = isset($disabled) && $disabled;
 649         if($disabled) {
 650             $channel->error($this->user, _('Login command is disabled.'));
 651             return;
 652         }
 653         $login_token = Login_token::staticGet('user_id',$this->user->id);
 654         if($login_token){
 655             $login_token->delete();
 656         }
 657         $login_token = new Login_token();
 658         $login_token->user_id = $this->user->id;
 659         $login_token->token = common_good_rand(16);
 660         $login_token->created = common_sql_now();
 661         $result = $login_token->insert();
 662         if (!$result) {
 663           common_log_db_error($login_token, 'INSERT', __FILE__);
 664           $channel->error($this->user, sprintf(_('Could not create login token for %s.'),
 665                                        $this->user->nickname));
 666           return;
 667         }
 668         $channel->output($this->user,
 669             sprintf(_('This link is useable only once, and is good for only 2 minutes: %s.'),
 670                     common_local_url('login',
 671                         array('user_id'=>$login_token->user_id, 'token'=>$login_token->token))));
 672     }
 673 }
 674
 675 class SubscriptionsCommand extends Command
 676 {
 677     function execute($channel)
 678     {
 679         $profile = $this->user->getSubscriptions(0);
 680         $nicknames=array();
 681         while ($profile->fetch()) {
 682             $nicknames[]=$profile->nickname;
 683         }
 684         if(count($nicknames)==0){
 685             $out=_('You are not subscribed to anyone.');
 686         }else{
 687             $out = ngettext('You are subscribed to this person:',
 688                 'You are subscribed to these people:',
 689                 count($nicknames));
 690             $out .= ' ';
 691             $out .= implode(', ',$nicknames);
 692         }
 693         $channel->output($this->user,$out);
 694     }
 695 }
 696
 697 class SubscribersCommand extends Command
 698 {
 699     function execute($channel)
 700     {
 701         $profile = $this->user->getSubscribers();
 702         $nicknames=array();
 703         while ($profile->fetch()) {
 704             $nicknames[]=$profile->nickname;
 705         }
 706         if(count($nicknames)==0){
 707             $out=_('No one is subscribed to you.');
 708         }else{
 709             $out = ngettext('This person is subscribed to you:',
 710                 'These people are subscribed to you:',
 711                 count($nicknames));
 712             $out .= ' ';
 713             $out .= implode(', ',$nicknames);
 714         }
 715         $channel->output($this->user,$out);
 716     }
 717 }
 718
 719 class GroupsCommand extends Command
 720 {
 721     function execute($channel)
 722     {
 723         $group = $this->user->getGroups();
 724         $groups=array();
 725         while ($group->fetch()) {
 726             $groups[]=$group->nickname;
 727         }
 728         if(count($groups)==0){
 729             $out=_('You are not a member of any groups.');
 730         }else{
 731             $out = ngettext('You are a member of this group:',
 732                 'You are a member of these groups:',
 733                 count($nicknames));
 734             $out.=implode(', ',$groups);
 735         }
 736         $channel->output($this->user,$out);
 737     }
 738 }
 739
 740 class HelpCommand extends Command
 741 {
 742     function execute($channel)
 743     {
 744         $channel->output($this->user,
 745                          _("Commands:\n".
 746                            "on - turn on notifications\n".
 747                            "off - turn off notifications\n".
 748                            "help - show this help\n".
 749                            "follow <nickname> - subscribe to user\n".
 750                            "groups - lists the groups you have joined\n".
 751                            "subscriptions - list the people you follow\n".
 752                            "subscribers - list the people that follow you\n".
 753                            "leave <nickname> - unsubscribe from user\n".
 754                            "d <nickname> <text> - direct message to user\n".
 755                            "get <nickname> - get last notice from user\n".
 756                            "whois <nickname> - get profile info on user\n".
 757                            "fav <nickname> - add user's last notice as a 'fave'\n".
 758                            "fav #<notice_id> - add notice with the given id as a 'fave'\n".
 759                            "repeat #<notice_id> - repeat a notice with a given id\n".
 760                            "repeat <nickname> - repeat the last notice from user\n".
 761                            "reply #<notice_id> - reply to notice with a given id\n".
 762                            "reply <nickname> - reply to the last notice from user\n".
 763                            "join <group> - join group\n".
 764                            "login - Get a link to login to the web interface\n".
 765                            "drop <group> - leave group\n".
 766                            "stats - get your stats\n".
 767                            "stop - same as 'off'\n".
 768                            "quit - same as 'off'\n".
 769                            "sub <nickname> - same as 'follow'\n".
 770                            "unsub <nickname> - same as 'leave'\n".
 771                            "last <nickname> - same as 'get'\n".
 772                            "on <nickname> - not yet implemented.\n".
 773                            "off <nickname> - not yet implemented.\n".
 774                            "nudge <nickname> - remind a user to update.\n".
 775                            "invite <phone number> - not yet implemented.\n".
 776                            "track <word> - not yet implemented.\n".
 777                            "untrack <word> - not yet implemented.\n".
 778                            "track off - not yet implemented.\n".
 779                            "untrack all - not yet implemented.\n".
 780                            "tracks - not yet implemented.\n".
 781                            "tracking - not yet implemented.\n"));
 782     }
 783 }