includes/FeedUtils.php

   1 <?php
   2
   3 // TODO: document
   4 class FeedUtils {
   5
   6         public static function checkPurge( $timekey, $key ) {
   7                 global $wgRequest, $wgUser, $messageMemc;
   8                 $purge = $wgRequest->getVal( 'action' ) === 'purge';
   9                 if ( $purge && $wgUser->isAllowed('purge') ) {
  10                         $messageMemc->delete( $timekey );
  11                         $messageMemc->delete( $key );
  12                 }
  13         }
  14
  15         public static function checkFeedOutput( $type ) {
  16                 global $wgFeed, $wgOut, $wgFeedClasses;
  17
  18                 if ( !$wgFeed ) {
  19                         global $wgOut;
  20                         $wgOut->addWikiMsg( 'feed-unavailable' );
  21                         return false;
  22                 }
  23
  24                 if( !isset( $wgFeedClasses[$type] ) ) {
  25                         wfHttpError( 500, "Internal Server Error", "Unsupported feed type." );
  26                         return false;
  27                 }
  28
  29                 return true;
  30         }
  31
  32         /**
  33         * Format a diff for the newsfeed
  34         */
  35         public static function formatDiff( $row ) {
  36                 global $wgUser;
  37
  38                 $titleObj = Title::makeTitle( $row->rc_namespace, $row->rc_title );
  39                 $timestamp = wfTimestamp( TS_MW, $row->rc_timestamp );
  40                 $actiontext = '';
  41                 if( $row->rc_type == RC_LOG ) {
  42                         if( $row->rc_deleted & LogPage::DELETED_ACTION ) {
  43                                 $actiontext = wfMsgHtml('rev-deleted-event');
  44                         } else {
  45                                 $actiontext = LogPage::actionText( $row->rc_log_type, $row->rc_log_action,
  46                                         $titleObj, $wgUser->getSkin(), LogPage::extractParams($row->rc_params,true,true) );
  47                         }
  48                 }
  49                 return self::formatDiffRow( $titleObj,
  50                         $row->rc_last_oldid, $row->rc_this_oldid,
  51                         $timestamp,
  52                         ($row->rc_deleted & Revision::DELETED_COMMENT) ? wfMsgHtml('rev-deleted-comment') : $row->rc_comment,
  53                         $actiontext );
  54         }
  55
  56         public static function formatDiffRow( $title, $oldid, $newid, $timestamp, $comment, $actiontext='' ) {
  57                 global $wgFeedDiffCutoff, $wgContLang, $wgUser;
  58                 wfProfileIn( __FUNCTION__ );
  59
  60                 $skin = $wgUser->getSkin();
  61                 # log enties
  62                 $completeText = '<p>' . implode( ' ',
  63                         array_filter(
  64                                 array(
  65                                         $actiontext,
  66                                         $skin->formatComment( $comment ) ) ) ) . "</p>\n";
  67
  68                 //NOTE: Check permissions for anonymous users, not current user.
  69                 //      No "privileged" version should end up in the cache.
  70                 //      Most feed readers will not log in anway.
  71                 $anon = new User();
  72                 $accErrors = $title->getUserPermissionsErrors( 'read', $anon, true );
  73
  74                 if( $title->getNamespace() >= 0 && !$accErrors ) {
  75                         if( $oldid ) {
  76                                 wfProfileIn( __FUNCTION__."-dodiff" );
  77
  78                                 #$diffText = $de->getDiff( wfMsg( 'revisionasof',
  79                                 #       $wgContLang->timeanddate( $timestamp ) ),
  80                                 #       wfMsg( 'currentrev' ) );
  81
  82                                 // Don't bother generating the diff if we won't be able to show it
  83                                 if ( $wgFeedDiffCutoff > 0 ) {
  84                                         $de = new DifferenceEngine( $title, $oldid, $newid );
  85                                         $diffText = $de->getDiff(
  86                                                 wfMsg( 'previousrevision' ), // hack
  87                                                 wfMsg( 'revisionasof',
  88                                                         $wgContLang->timeanddate( $timestamp ) ) );
  89                                 }
  90
  91                                 if ( ( strlen( $diffText ) > $wgFeedDiffCutoff ) || ( $wgFeedDiffCutoff <= 0 ) ) {
  92                                         // Omit large diffs
  93                                         $diffLink = $title->escapeFullUrl(
  94                                                 'diff=' . $newid .
  95                                                 '&oldid=' . $oldid );
  96                                         $diffText = '<a href="' .
  97                                                 $diffLink .
  98                                                 '">' .
  99                                                 htmlspecialchars( wfMsgForContent( 'showdiff' ) ) .
 100                                                 '</a>';
 101                                 } elseif ( $diffText === false ) {
 102                                         // Error in diff engine, probably a missing revision
 103                                         $diffText = "<p>Can't load revision $newid</p>";
 104                                 } else {
 105                                         // Diff output fine, clean up any illegal UTF-8
 106                                         $diffText = UtfNormal::cleanUp( $diffText );
 107                                         $diffText = self::applyDiffStyle( $diffText );
 108                                 }
 109                                 wfProfileOut( __FUNCTION__."-dodiff" );
 110                         } else {
 111                                 $rev = Revision::newFromId( $newid );
 112                                 if( is_null( $rev ) ) {
 113                                         $newtext = '';
 114                                 } else {
 115                                         $newtext = $rev->getText();
 116                                 }
 117                                 $diffText = '<p><b>' . wfMsg( 'newpage' ) . '</b></p>' .
 118                                         '<div>' . nl2br( htmlspecialchars( $newtext ) ) . '</div>';
 119                         }
 120                         $completeText .= $diffText;
 121                 }
 122
 123                 wfProfileOut( __FUNCTION__ );
 124                 return $completeText;
 125         }
 126
 127         /**
 128         * Hacky application of diff styles for the feeds.
 129         * Might be 'cleaner' to use DOM or XSLT or something,
 130         * but *gack* it's a pain in the ass.
 131         *
 132         * @param $text String:
 133         * @return string
 134         * @private
 135         */
 136         public static function applyDiffStyle( $text ) {
 137                 $styles = array(
 138                         'diff'             => 'background-color: white; color:black;',
 139                         'diff-otitle'      => 'background-color: white; color:black;',
 140                         'diff-ntitle'      => 'background-color: white; color:black;',
 141                         'diff-addedline'   => 'background: #cfc; color:black; font-size: smaller;',
 142                         'diff-deletedline' => 'background: #ffa; color:black; font-size: smaller;',
 143                         'diff-context'     => 'background: #eee; color:black; font-size: smaller;',
 144                         'diffchange'       => 'color: red; font-weight: bold; text-decoration: none;',
 145                 );
 146
 147                 foreach( $styles as $class => $style ) {
 148                         $text = preg_replace( "/(<[^>]+)class=(['\"])$class\\2([^>]*>)/",
 149                                 "\\1style=\"$style\"\\3", $text );
 150                 }
 151
 152                 return $text;
 153         }
 154
 155 }