begin cleanup on magnus' url upload thingy
[lhc/web/wiklou.git] / includes / UserMailer.php
index b887b1e..24dab67 100644 (file)
@@ -16,7 +16,7 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @author <brion@pobox.com>
@@ -25,8 +25,6 @@
  * @package MediaWiki
  */
 
-require_once( 'WikiError.php' );
-
 /**
  * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
  */
@@ -49,14 +47,18 @@ class MailAddress {
                        $this->name = strval( $name );
                }
        }
-       
+
        /**
         * Return formatted and quoted address to insert into SMTP headers
         * @return string
         */
        function toString() {
                if( $this->name != '' ) {
-                       return wfQuotedPrintable( $this->name ) . " <" . $this->address . ">";
+                       $quoted = wfQuotedPrintable( $this->name );
+                       if( strpos( $quoted, '.' ) !== false ) {
+                               $quoted = '"' . $quoted . '"';
+                       }
+                       return "$quoted <{$this->address}>";
                } else {
                        return $this->address;
                }
@@ -69,11 +71,11 @@ class MailAddress {
  * array of parameters. It requires PEAR:Mail to do that.
  * Otherwise it just uses the standard PHP 'mail' function.
  *
- * @param MailAddress $to recipient's email
- * @param MailAddress $from sender's email
- * @param string $subject email's subject
- * @param string $body email's text
- * @param string $replyto optional reply-to email (default : false)
+ * @param $to MailAddress: recipient's email
+ * @param $from MailAddress: sender's email
+ * @param $subject String: email's subject.
+ * @param $body String: email's text.
+ * @param $replyto String: optional reply-to email (default: false).
  */
 function userMailer( $to, $from, $subject, $body, $replyto=false ) {
        global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString;
@@ -82,10 +84,10 @@ function userMailer( $to, $from, $subject, $body, $replyto=false ) {
                require_once( 'Mail.php' );
 
                $timestamp = time();
-               $dest = $to->toString();
-               
+               $dest = $to->address;
+
                $headers['From'] = $from->toString();
-               $headers['To'] = $dest;
+               $headers['To'] = $to->toString();
                if ( $replyto ) {
                        $headers['Reply-To'] = $replyto;
                }
@@ -99,7 +101,7 @@ function userMailer( $to, $from, $subject, $body, $replyto=false ) {
 
                // Create the mail object using the Mail::factory method
                $mail_object =& Mail::factory('smtp', $wgSMTP);
-               wfDebug( "Sending mail via PEAR::Mail to $dest" );
+               wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
                $mailResult =& $mail_object->send($dest, $headers, $body);
 
                # Based on the result return an error string,
@@ -126,7 +128,7 @@ function userMailer( $to, $from, $subject, $body, $replyto=false ) {
                }
 
                $dest = $to->toString();
-               
+
                $wgErrorString = '';
                set_error_handler( 'mailErrorHandler' );
                wfDebug( "Sending mail via internal mail() function to $dest\n" );
@@ -143,8 +145,8 @@ function userMailer( $to, $from, $subject, $body, $replyto=false ) {
 /**
  * Get the mail error message in global $wgErrorString
  *
- * @parameter $code error number
- * @parameter $string error message
+ * @param $code Integer: error number
+ * @param $string String: error message
  */
 function mailErrorHandler( $code, $string ) {
        global $wgErrorString;
@@ -174,21 +176,20 @@ function mailErrorHandler( $code, $string ) {
  *
  */
 class EmailNotification {
-       /**#@+
-        * @access private
+       /**@{{
+        * @private
         */
        var $to, $subject, $body, $replyto, $from;
        var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
 
-       /**#@-*/
+       /**@}}*/
 
        /**
         * @todo document
-        * @param $currentPage
-        * @param $currentNs
+        * @param $title Title object
         * @param $timestamp
-        * @param $currentSummary
-        * @param $currentMinorEdit
+        * @param $summary
+        * @param $minorEdit
         * @param $oldid (default: false)
         */
        function notifyOnPageChange(&$title, $timestamp, $summary, $minorEdit, $oldid=false) {
@@ -231,7 +232,7 @@ class EmailNotification {
                        if( $userCondition ) {
                                $dbr =& wfGetDB( DB_MASTER );
                                extract( $dbr->tableNames( 'watchlist' ) );
-                               
+
                                $res = $dbr->select( 'watchlist', array( 'wl_user' ),
                                        array(
                                                'wl_title' => $title->getDBkey(),
@@ -239,7 +240,7 @@ class EmailNotification {
                                                $userCondition,
                                                'wl_notificationtimestamp IS NULL',
                                        ), $fname );
-       
+
                                # if anyone is watching ... set up the email message text which is
                                # common for all receipients ...
                                if ( $dbr->numRows( $res ) > 0 ) {
@@ -248,23 +249,26 @@ class EmailNotification {
                                        $this->summary = $summary;
                                        $this->minorEdit = $minorEdit;
                                        $this->oldid = $oldid;
-       
+
                                        $this->composeCommonMailtext();
                                        $watchingUser = new User();
-       
+
                                        # ... now do for all watching users ... if the options fit
                                        for ($i = 1; $i <= $dbr->numRows( $res ); $i++) {
-       
+
                                                $wuser = $dbr->fetchObject( $res );
                                                $watchingUser->setID($wuser->wl_user);
+                                               
                                                if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
-                                                       ( $enotifusertalkpage && $watchingUser->getOption('enotifusertalkpages') )
+                                                       ( $enotifusertalkpage
+                                                               && $watchingUser->getOption('enotifusertalkpages')
+                                                               && $title->equals( $watchingUser->getTalkPage() ) )
                                                && (!$minorEdit || ($wgEnotifMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
                                                && ($watchingUser->isEmailConfirmed() ) ) {
                                                        # ... adjust remaining text and page edit time placeholders
                                                        # which needs to be personalized for each user
                                                        $this->composeAndSendPersonalisedMail( $watchingUser );
-       
+
                                                } # if the watching user has an email address in the preferences
                                        }
                                }
@@ -285,11 +289,11 @@ class EmailNotification {
                        );
                        # FIXME what do we do on failure ?
                }
-
+               wfProfileOut( $fname );
        } # function NotifyOnChange
 
        /**
-        * @access private
+        * @private
         */
        function composeCommonMailtext() {
                global $wgUser, $wgEmergencyContact, $wgNoReplyAddress;
@@ -327,7 +331,7 @@ class EmailNotification {
                $pagetitle = $this->title->getPrefixedText();
                $keys['$PAGETITLE']          = $pagetitle;
                $keys['$PAGETITLE_URL']      = $this->title->getFullUrl();
-               
+
                $keys['$PAGEMINOREDIT']      = $medit;
                $keys['$PAGESUMMARY']        = $summary;
 
@@ -386,7 +390,7 @@ class EmailNotification {
         * @param User $watchingUser
         * @param object $mail
         * @return bool
-        * @access private
+        * @private
         */
        function composeAndSendPersonalisedMail( $watchingUser ) {
                global $wgLang;
@@ -397,7 +401,7 @@ class EmailNotification {
                $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $this->body );
 
                $timecorrection = $watchingUser->getOption( 'timecorrection' );
-               
+
                # $PAGEEDITDATE is the time and date of the page change
                # expressed in terms of individual local time of the notification
                # recipient, i.e. watching user