From ca1d64e58411cc6401a757f0e324ec1a6bc37107 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Sat, 4 Dec 2010 13:39:18 +0000 Subject: [PATCH] Stylise UserMailer.php ; added some "public" to public functions --- includes/UserMailer.php | 155 ++++++++++++++++++++-------------------- 1 file changed, 77 insertions(+), 78 deletions(-) diff --git a/includes/UserMailer.php b/includes/UserMailer.php index 4d7c57a013..0749aafa17 100644 --- a/includes/UserMailer.php +++ b/includes/UserMailer.php @@ -36,7 +36,7 @@ class MailAddress { * @param $realName String: human-readable real name if a string address is given */ function __construct( $address, $name = null, $realName = null ) { - if( is_object( $address ) && $address instanceof User ) { + if ( is_object( $address ) && $address instanceof User ) { $this->address = $address->getEmail(); $this->name = $address->getName(); $this->realName = $address->getRealName(); @@ -55,11 +55,11 @@ class MailAddress { # PHP's mail() implementation under Windows is somewhat shite, and # can't handle "Joe Bloggs " format email addresses, # so don't bother generating them - if( $this->name != '' && !wfIsWindows() ) { + if ( $this->name != '' && !wfIsWindows() ) { global $wgEnotifUseRealName; $name = ( $wgEnotifUseRealName && $this->realName ) ? $this->realName : $this->name; $quoted = wfQuotedPrintable( $name ); - if( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) { + if ( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) { $quoted = '"' . $quoted . '"'; } return "$quoted <{$this->address}>"; @@ -79,16 +79,15 @@ class MailAddress { */ class UserMailer { static $mErrorString; - + /** * Send mail using a PEAR mailer */ - protected static function sendWithPear($mailer, $dest, $headers, $body) - { - $mailResult = $mailer->send($dest, $headers, $body); + protected static function sendWithPear( $mailer, $dest, $headers, $body ) { + $mailResult = $mailer->send( $dest, $headers, $body ); # Based on the result return an error string, - if( PEAR::isError( $mailResult ) ) { + if ( PEAR::isError( $mailResult ) ) { wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" ); return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() ); } else { @@ -110,23 +109,23 @@ class UserMailer { * @param $contentType String: optional custom Content-Type * @return Status object */ - static function send( $to, $from, $subject, $body, $replyto=null, $contentType=null ) { + public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = null ) { global $wgSMTP, $wgOutputEncoding, $wgEnotifImpersonal; global $wgEnotifMaxRecips, $wgAdditionalMailParams; if ( is_array( $to ) ) { // This wouldn't be necessary if implode() worked on arrays of // objects using __toString(). http://bugs.php.net/bug.php?id=36612 - foreach( $to as $t ) { + foreach ( $to as $t ) { $emails .= $t->toString() . ","; } $emails = rtrim( $emails, ',' ); - wfDebug( __METHOD__.': sending mail to ' . $emails . "\n" ); + wfDebug( __METHOD__ . ': sending mail to ' . $emails . "\n" ); } else { - wfDebug( __METHOD__.': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" ); + wfDebug( __METHOD__ . ': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" ); } - if (is_array( $wgSMTP )) { + if ( is_array( $wgSMTP ) ) { $found = false; $pathArray = explode( PATH_SEPARATOR, get_include_path() ); foreach ( $pathArray as $path ) { @@ -140,20 +139,20 @@ class UserMailer { } require_once( 'Mail.php' ); - $msgid = str_replace(" ", "_", microtime()); - if (function_exists('posix_getpid')) + $msgid = str_replace( " ", "_", microtime() ); + if ( function_exists( 'posix_getpid' ) ) $msgid .= '.' . posix_getpid(); - if (is_array($to)) { + if ( is_array( $to ) ) { $dest = array(); - foreach ($to as $u) + foreach ( $to as $u ) $dest[] = $u->address; } else $dest = $to->address; $headers['From'] = $from->toString(); - if ($wgEnotifImpersonal) { + if ( $wgEnotifImpersonal ) { $headers['To'] = 'undisclosed-recipients:;'; } else { @@ -166,8 +165,8 @@ class UserMailer { $headers['Subject'] = wfQuotedPrintable( $subject ); $headers['Date'] = date( 'r' ); $headers['MIME-Version'] = '1.0'; - $headers['Content-type'] = (is_null($contentType) ? - 'text/plain; charset='.$wgOutputEncoding : $contentType); + $headers['Content-type'] = ( is_null( $contentType ) ? + 'text/plain; charset=' . $wgOutputEncoding : $contentType ); $headers['Content-transfer-encoding'] = '8bit'; $headers['Message-ID'] = "<$msgid@" . $wgSMTP['IDHost'] . '>'; // FIXME $headers['X-Mailer'] = 'MediaWiki mailer'; @@ -175,8 +174,8 @@ class UserMailer { wfSuppressWarnings(); // Create the mail object using the Mail::factory method - $mail_object =& Mail::factory('smtp', $wgSMTP); - if( PEAR::isError( $mail_object ) ) { + $mail_object =& Mail::factory( 'smtp', $wgSMTP ); + if ( PEAR::isError( $mail_object ) ) { wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" ); wfRestoreWarnings(); return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() ); @@ -184,9 +183,9 @@ class UserMailer { wfDebug( "Sending mail via PEAR::Mail to $dest\n" ); $chunks = array_chunk( (array)$dest, $wgEnotifMaxRecips ); - foreach ($chunks as $chunk) { - $status = self::sendWithPear($mail_object, $chunk, $headers, $body); - if( !$status->isOK() ) { + foreach ( $chunks as $chunk ) { + $status = self::sendWithPear( $mail_object, $chunk, $headers, $body ); + if ( !$status->isOK() ) { wfRestoreWarnings(); return $status; } @@ -205,27 +204,27 @@ class UserMailer { } else { $endl = "\n"; } - $ctype = (is_null($contentType) ? - 'text/plain; charset='.$wgOutputEncoding : $contentType); + $ctype = ( is_null( $contentType ) ? + 'text/plain; charset=' . $wgOutputEncoding : $contentType ); $headers = "MIME-Version: 1.0$endl" . "Content-type: $ctype$endl" . "Content-Transfer-Encoding: 8bit$endl" . - "X-Mailer: MediaWiki mailer$endl". + "X-Mailer: MediaWiki mailer$endl" . 'From: ' . $from->toString(); - if ($replyto) { + if ( $replyto ) { $headers .= "{$endl}Reply-To: " . $replyto->toString(); } wfDebug( "Sending mail via internal mail() function\n" ); - + self::$mErrorString = ''; $html_errors = ini_get( 'html_errors' ); ini_set( 'html_errors', '0' ); set_error_handler( array( 'UserMailer', 'errorHandler' ) ); - if (is_array($to)) { - foreach ($to as $recip) { + if ( is_array( $to ) ) { + foreach ( $to as $recip ) { $sent = mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams ); } } else { @@ -238,8 +237,8 @@ class UserMailer { if ( self::$mErrorString ) { wfDebug( "Error sending mail: " . self::$mErrorString . "\n" ); return Status::newFatal( 'php-mail-error', self::$mErrorString ); - } elseif (! $sent ) { - //mail function only tells if there's an error + } elseif ( ! $sent ) { + // mail function only tells if there's an error wfDebug( "Error sending mail\n" ); return Status::newFatal( 'php-mail-error-unknown' ); } else { @@ -261,7 +260,7 @@ class UserMailer { /** * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name */ - static function rfc822Phrase( $phrase ) { + public static function rfc822Phrase( $phrase ) { $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) ); return '"' . $phrase . '"'; } @@ -305,15 +304,15 @@ class EmailNotification { * @param $minorEdit * @param $oldid (default: false) */ - function notifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid = false) { + public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) { global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker; - if ($title->getNamespace() < 0) + if ( $title->getNamespace() < 0 ) return; // Build a list of users to notfiy $watchers = array(); - if ($wgEnotifWatchlist || $wgShowUpdatedMarker) { + if ( $wgEnotifWatchlist || $wgShowUpdatedMarker ) { $dbw = wfGetDB( DB_MASTER ); $res = $dbw->select( array( 'watchlist' ), array( 'wl_user' ), @@ -327,7 +326,7 @@ class EmailNotification { foreach ( $res as $row ) { $watchers[] = intval( $row->wl_user ); } - if ($watchers) { + if ( $watchers ) { // Update wl_notificationtimestamp for all watching users except // the editor $dbw->begin(); @@ -344,7 +343,7 @@ class EmailNotification { } } - if ($wgEnotifUseJobQ) { + if ( $wgEnotifUseJobQ ) { $params = array( "editor" => $editor->getName(), "editorID" => $editor->getID(), @@ -352,7 +351,7 @@ class EmailNotification { "summary" => $summary, "minorEdit" => $minorEdit, "oldid" => $oldid, - "watchers" => $watchers); + "watchers" => $watchers ); $job = new EnotifNotifyJob( $title, $params ); $job->insert(); } else { @@ -375,7 +374,7 @@ class EmailNotification { * @param $oldid int Revision ID * @param $watchers array of user IDs */ - function actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers) { + public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) { # we use $wgPasswordSender as sender's address global $wgEnotifWatchlist; global $wgEnotifMinorEdits, $wgEnotifUserTalk; @@ -386,7 +385,7 @@ class EmailNotification { # 1. EmailNotification for pages (other than user_talk pages) must be enabled # 2. minor edits (changes) are only regarded if the global flag indicates so - $isUserTalkPage = ($title->getNamespace() == NS_USER_TALK); + $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK ); $this->title = $title; $this->timestamp = $timestamp; @@ -398,23 +397,23 @@ class EmailNotification { $userTalkId = false; - if ( !$minorEdit || ($wgEnotifMinorEdits && !$editor->isAllowed('nominornewtalk') ) ) { + if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) { if ( $wgEnotifUserTalk && $isUserTalkPage ) { $targetUser = User::newFromName( $title->getText() ); if ( !$targetUser || $targetUser->isAnon() ) { - wfDebug( __METHOD__.": user talk page edited, but user does not exist\n" ); + wfDebug( __METHOD__ . ": user talk page edited, but user does not exist\n" ); } elseif ( $targetUser->getId() == $editor->getId() ) { - wfDebug( __METHOD__.": user edited their own talk page, no notification sent\n" ); - } elseif( $targetUser->getOption( 'enotifusertalkpages' ) ) { - if( $targetUser->isEmailConfirmed() ) { - wfDebug( __METHOD__.": sending talk page update notification\n" ); + wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent\n" ); + } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) ) { + if ( $targetUser->isEmailConfirmed() ) { + wfDebug( __METHOD__ . ": sending talk page update notification\n" ); $this->compose( $targetUser ); $userTalkId = $targetUser->getId(); } else { - wfDebug( __METHOD__.": talk page owner doesn't have validated email\n" ); + wfDebug( __METHOD__ . ": talk page owner doesn't have validated email\n" ); } } else { - wfDebug( __METHOD__.": talk page owner doesn't want notifications\n" ); + wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" ); } } @@ -423,7 +422,7 @@ class EmailNotification { $userArray = UserArray::newFromIDs( $watchers ); foreach ( $userArray as $watchingUser ) { if ( $watchingUser->getOption( 'enotifwatchlistpages' ) && - ( !$minorEdit || $watchingUser->getOption('enotifminoredits') ) && + ( !$minorEdit || $watchingUser->getOption( 'enotifminoredits' ) ) && $watchingUser->isEmailConfirmed() && $watchingUser->getID() != $userTalkId ) { @@ -453,8 +452,8 @@ class EmailNotification { $this->composed_common = true; - $summary = ($this->summary == '') ? ' - ' : $this->summary; - $medit = ($this->minorEdit) ? wfMsgForContent( 'minoredit' ) : ''; + $summary = ( $this->summary == '' ) ? ' - ' : $this->summary; + $medit = ( $this->minorEdit ) ? wfMsgForContent( 'minoredit' ) : ''; # You as the WikiAdmin and Sysops can make use of plenty of # named variables when composing your notification emails while @@ -466,7 +465,7 @@ class EmailNotification { $replyto = ''; /* fail safe */ $keys = array(); - if( $this->oldid ) { + if ( $this->oldid ) { $difflink = $this->title->getFullUrl( 'diff=0&oldid=' . $this->oldid ); $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink ); $keys['$OLDID'] = $this->oldid; @@ -478,13 +477,13 @@ class EmailNotification { $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' ); } - if ($wgEnotifImpersonal && $this->oldid) { + if ( $wgEnotifImpersonal && $this->oldid ) { /* * For impersonal mail, show a diff link to the last * revision. */ - $keys['$NEWPAGE'] = wfMsgForContent('enotif_lastdiff', - $this->title->getFullURL("oldid={$this->oldid}&diff=next")); + $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff', + $this->title->getFullURL( "oldid={$this->oldid}&diff=next" ) ); } $body = strtr( $body, $keys ); @@ -505,10 +504,10 @@ class EmailNotification { $name = $wgEnotifUseRealName ? $editor->getRealName() : $editor->getName(); $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName ); $editorAddress = new MailAddress( $editor ); - if( $wgEnotifRevealEditorAddress + if ( $wgEnotifRevealEditorAddress && ( $editor->getEmail() != '' ) && $editor->getOption( 'enotifrevealaddr' ) ) { - if( $wgEnotifFromEditor ) { + if ( $wgEnotifFromEditor ) { $from = $editorAddress; } else { $from = $adminAddress; @@ -519,14 +518,14 @@ class EmailNotification { $replyto = new MailAddress( $wgNoReplyAddress ); } - if( $editor->isIP( $name ) ) { - #real anon (user:xxx.xxx.xxx.xxx) - $utext = wfMsgForContent('enotif_anon_editor', $name); - $subject = str_replace('$PAGEEDITOR', $utext, $subject); + if ( $editor->isIP( $name ) ) { + # real anon (user:xxx.xxx.xxx.xxx) + $utext = wfMsgForContent( 'enotif_anon_editor', $name ); + $subject = str_replace( '$PAGEEDITOR', $utext, $subject ); $keys['$PAGEEDITOR'] = $utext; $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' ); } else { - $subject = str_replace('$PAGEEDITOR', $name, $subject); + $subject = str_replace( '$PAGEEDITOR', $name, $subject ); $keys['$PAGEEDITOR'] = $name; $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name ); $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl(); @@ -588,7 +587,7 @@ class EmailNotification { // The mail command will not parse this properly while talking with the MTA. $to = new MailAddress( $watchingUser ); $name = $wgEnotifUseRealName ? $watchingUser->getRealName() : $watchingUser->getName(); - $body = str_replace( '$WATCHINGUSERNAME', $name , $this->body ); + $body = str_replace( '$WATCHINGUSERNAME', $name, $this->body ); $timecorrection = $watchingUser->getOption( 'timecorrection' ); @@ -596,15 +595,15 @@ class EmailNotification { # expressed in terms of individual local time of the notification # recipient, i.e. watching user $body = str_replace( - array( '$PAGEEDITDATEANDTIME', + array( '$PAGEEDITDATEANDTIME', '$PAGEEDITDATE', '$PAGEEDITTIME' ), - array( $wgContLang->timeanddate( $this->timestamp, true, false, $timecorrection ), + array( $wgContLang->timeanddate( $this->timestamp, true, false, $timecorrection ), $wgContLang->date( $this->timestamp, true, false, $timecorrection ), $wgContLang->time( $this->timestamp, true, false, $timecorrection ) ), - $body); + $body ); - return UserMailer::send($to, $this->from, $this->subject, $body, $this->replyto); + return UserMailer::send( $to, $this->from, $this->subject, $body, $this->replyto ); } /** @@ -614,17 +613,17 @@ class EmailNotification { function sendImpersonal( $addresses ) { global $wgContLang; - if (empty($addresses)) + if ( empty( $addresses ) ) return; $body = str_replace( - array( '$WATCHINGUSERNAME', - '$PAGEEDITDATE'), - array( wfMsgForContent('enotif_impersonal_salutation'), - $wgContLang->timeanddate($this->timestamp, true, false, false)), - $this->body); + array( '$WATCHINGUSERNAME', + '$PAGEEDITDATE' ), + array( wfMsgForContent( 'enotif_impersonal_salutation' ), + $wgContLang->timeanddate( $this->timestamp, true, false, false ) ), + $this->body ); - return UserMailer::send($addresses, $this->from, $this->subject, $body, $this->replyto); + return UserMailer::send( $addresses, $this->from, $this->subject, $body, $this->replyto ); } } # end of class EmailNotification @@ -639,7 +638,7 @@ function wfRFC822Phrase( $s ) { return UserMailer::rfc822Phrase( $s ); } -function userMailer( $to, $from, $subject, $body, $replyto=null ) { +function userMailer( $to, $from, $subject, $body, $replyto = null ) { wfDeprecated( __FUNCTION__ ); return UserMailer::send( $to, $from, $subject, $body, $replyto ); } -- 2.20.1