X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fimplugin.php;h=5b0f3dbe092fa42dbd73d01dc3e727392151d1bb;hb=2b58d6b774e329a71b8e9b7462c1ae81b70c98ca;hp=a6a30b042f5f8d289392b3531e46159396507305;hpb=9ccf65a3116c925b30c5c5d9b8926b26546c9694;p=quix0rs-gnu-social.git diff --git a/lib/implugin.php b/lib/implugin.php index a6a30b042f..5b0f3dbe09 100644 --- a/lib/implugin.php +++ b/lib/implugin.php @@ -42,7 +42,6 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - abstract class ImPlugin extends Plugin { //name of this IM transport @@ -50,6 +49,8 @@ abstract class ImPlugin extends Plugin //list of screennames that should get all public notices public $public = array(); + protected $requires_cli = true; + /** * normalize a screenname for comparison * @@ -59,7 +60,6 @@ abstract class ImPlugin extends Plugin */ abstract function normalize($screenname); - /** * validate (ensure the validity of) a screenname * @@ -86,7 +86,7 @@ abstract class ImPlugin extends Plugin * * @return boolean success value */ - function sendNotice($screenname, $notice) + function sendNotice($screenname, Notice $notice) { return $this->sendMessage($screenname, $this->formatNotice($notice)); } @@ -107,7 +107,7 @@ abstract class ImPlugin extends Plugin * receive a raw message * Raw IM data is taken from the incoming queue, and passed to this function. * It should parse the raw message and call handleIncoming() - * + * * Returning false may CAUSE REPROCESSING OF THE QUEUE ITEM, and should * be used for temporary failures only. For permanent failures such as * unrecognized addresses, return true to indicate your processing has @@ -135,7 +135,7 @@ abstract class ImPlugin extends Plugin */ function microiduri($screenname) { - return $this->transport . ':' . $screenname; + return $this->transport . ':' . $screenname; } //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - MISC ========================\ @@ -172,7 +172,7 @@ abstract class ImPlugin extends Plugin { $user_im_prefs = $this->getUserImPrefsFromScreenname($screenname); if($user_im_prefs){ - $user = User::staticGet('id', $user_im_prefs->user_id); + $user = User::getKV('id', $user_im_prefs->user_id); $user_im_prefs->free(); return $user; }else{ @@ -180,7 +180,6 @@ abstract class ImPlugin extends Plugin } } - /** * given a screenname, get the User_im_prefs object for this transport * @@ -200,7 +199,6 @@ abstract class ImPlugin extends Plugin } } - /** * given a User, get their screenname * @@ -208,7 +206,7 @@ abstract class ImPlugin extends Plugin * * @return string screenname of that user */ - function get_screenname($user) + function getScreenname($user) { $user_im_prefs = $this->getUserImPrefsFromUser($user); if ($user_im_prefs) { @@ -218,7 +216,6 @@ abstract class ImPlugin extends Plugin } } - /** * given a User, get their User_im_prefs * @@ -253,7 +250,7 @@ abstract class ImPlugin extends Plugin } /** - * send a confirmation code to a user + * Send a confirmation code to a user * * @param string $screenname screenname sending to * @param string $code the confirmation code @@ -263,13 +260,16 @@ abstract class ImPlugin extends Plugin */ function sendConfirmationCode($screenname, $code, $user) { - $body = sprintf(_('User "%s" on %s has said that your %s screenname belongs to them. ' . - 'If that\'s true, you can confirm by clicking on this URL: ' . - '%s' . + // TRANS: Body text for confirmation code e-mail. + // TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename, + // TRANS: %3$s is the display name of an IM plugin. + $body = sprintf(_('User "%1$s" on %2$s has said that your %3$s screenname belongs to them. ' . + 'If that is true, you can confirm by clicking on this URL: ' . + '%4$s' . ' . (If you cannot click it, copy-and-paste it into the ' . - 'address bar of your browser). If that user isn\'t you, ' . - 'or if you didn\'t request this confirmation, just ignore this message.'), - $user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', array('code' => $code))); + 'address bar of your browser). If that user is not you, ' . + 'or if you did not request this confirmation, just ignore this message.'), + $user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', null, array('code' => $code))); return $this->sendMessage($screenname, $body); } @@ -285,7 +285,7 @@ abstract class ImPlugin extends Plugin * @return boolean success flag */ - function public_notice($notice) + function publicNotice($notice) { // Now, users who want everything @@ -318,13 +318,12 @@ abstract class ImPlugin extends Plugin * @return boolean success flag */ - function broadcast_notice($notice) + function broadcastNotice($notice) { - $ni = $notice->whoGets(); foreach ($ni as $user_id => $reason) { - $user = User::staticGet($user_id); + $user = User::getKV($user_id); if (empty($user)) { // either not a local user, or just not found continue; @@ -350,7 +349,9 @@ abstract class ImPlugin extends Plugin case NOTICE_INBOX_SOURCE_GROUP: break; default: - throw new Exception(sprintf(_("Unknown inbox source %d."), $reason)); + // TRANS: Exception thrown when trying to deliver a notice to an unknown inbox. + // TRANS: %d is the unknown inbox ID (number). + throw new Exception(sprintf(_('Unknown inbox source %d.'), $reason)); } common_log(LOG_INFO, @@ -371,10 +372,19 @@ abstract class ImPlugin extends Plugin * @return string plain-text version of the notice, with user nickname prefixed */ - function formatNotice($notice) + protected function formatNotice(Notice $notice) { $profile = $notice->getProfile(); - return $profile->nickname . ': ' . $notice->content . ' [' . $notice->id . ']'; + + try { + $parent = $notice->getParent(); + $orig_profile = $parent->getProfile(); + $nicknames = sprintf('%1$s => %2$s', $profile->nickname, $orig_profile->nickname); + } catch (Exception $e) { + $nicknames = $profile->nickname; + } + + return sprintf('%1$s: %2$s [%3$u]', $nicknames, $notice->content, $notice->id); } //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - RECEIVING ========================\ @@ -402,7 +412,7 @@ abstract class ImPlugin extends Plugin * @param string $txt message text * @return boolean true if autoreply */ - protected function is_autoreply($txt) + protected function isAutoreply($txt) { if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) { return true; @@ -418,7 +428,7 @@ abstract class ImPlugin extends Plugin * @param string $txt message text * @return boolean true if OTR */ - protected function is_otr($txt) + protected function isOtr($txt) { if (preg_match('/^\?OTR/', $txt)) { return true; @@ -453,10 +463,10 @@ abstract class ImPlugin extends Plugin if ($this->handleCommand($user, $notice_text)) { common_log(LOG_INFO, "Command message by $from handled."); return; - } else if ($this->is_autoreply($notice_text)) { + } else if ($this->isAutoreply($notice_text)) { common_log(LOG_INFO, 'Ignoring auto reply from ' . $from); return; - } else if ($this->is_otr($notice_text)) { + } else if ($this->isOtr($notice_text)) { common_log(LOG_INFO, 'Ignoring OTR from ' . $from); return; } else { @@ -486,9 +496,14 @@ abstract class ImPlugin extends Plugin $body = trim(strip_tags($body)); $content_shortened = common_shorten_links($body); if (Notice::contentTooLong($content_shortened)) { - $this->sendFromSite($screenname, sprintf(_('Message too long - maximum is %1$d characters, you sent %2$d.'), - Notice::maxContent(), - mb_strlen($content_shortened))); + $this->sendFromSite($screenname, + // TRANS: Message given when a status is too long. %1$s is the maximum number of characters, + // TRANS: %2$s is the number of characters sent (used for plural). + sprintf(_m('Message too long - maximum is %1$d character, you sent %2$d.', + 'Message too long - maximum is %1$d characters, you sent %2$d.', + Notice::maxContent()), + Notice::maxContent(), + mb_strlen($content_shortened))); return; } @@ -500,7 +515,6 @@ abstract class ImPlugin extends Plugin return; } - common_broadcast_notice($notice); common_log(LOG_INFO, 'Added notice ' . $notice->id . ' from user ' . $user->nickname); $notice->free(); @@ -508,7 +522,7 @@ abstract class ImPlugin extends Plugin } //========================EVENT HANDLERS========================\ - + /** * Register notice queue handler * @@ -518,9 +532,14 @@ abstract class ImPlugin extends Plugin */ function onEndInitializeQueueManager($manager) { - $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im'); - $manager->connect($this->transport, new ImQueueHandler($this)); - $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im'); + // If we don't require CLI mode, or if we do and GNUSOCIAL_CLI _is_ set, then connect the transports + // This check is made mostly because some IM plugins can't deliver to transports unless they + // have continously running daemons (such as XMPP) and we can't have that over HTTP requests. + if (!$this->requires_cli || defined('GNUSOCIAL_CLI')) { + $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im'); + $manager->connect($this->transport, new ImQueueHandler($this)); + $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im'); + } return true; } @@ -532,7 +551,7 @@ abstract class ImPlugin extends Plugin function onStartEnqueueNotice($notice, &$transports) { - $profile = Profile::staticGet($notice->profile_id); + $profile = Profile::getKV($notice->profile_id); if (!$profile) { common_log(LOG_WARNING, 'Refusing to broadcast notice with ' . @@ -617,15 +636,22 @@ abstract class ImPlugin extends Plugin return true; } + function onHaveImPlugin(&$haveImPlugin) { + $haveImPlugin = true; // set flag true (we're loaded, after all!) + return false; // stop looking + } + function initialize() { if( ! common_config('queue', 'enabled')) { - throw new ServerException("Queueing must be enabled to use IM plugins"); + // TRANS: Server exception thrown trying to initialise an IM plugin without meeting all prerequisites. + throw new ServerException(_('Queueing must be enabled to use IM plugins.')); } if(is_null($this->transport)){ - throw new ServerException('transport cannot be null'); + // TRANS: Server exception thrown trying to initialise an IM plugin without a transport method. + throw new ServerException(_('Transport cannot be null.')); } } }