first commit

1 files changed, 260 insertions, 0 deletions

diff --git a/www/wiki/includes/FeedUtils.php b/www/wiki/includes/FeedUtils.php
new file mode 100644
index 00000000..4dde52d0
--- /dev/null
+++ b/www/wiki/includes/FeedUtils.php
@@ -0,0 +1,260 @@
+<?php
+/**
+ * Helper functions for feeds.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Feed
+ */
+
+/**
+ * Helper functions for feeds
+ *
+ * @ingroup Feed
+ */
+class FeedUtils {
+
+	/**
+	 * Check whether feed's cache should be cleared; for changes feeds
+	 * If the feed should be purged; $timekey and $key will be removed from cache
+	 *
+	 * @param string $timekey Cache key of the timestamp of the last item
+	 * @param string $key Cache key of feed's content
+	 */
+	public static function checkPurge( $timekey, $key ) {
+		global $wgRequest, $wgUser;
+
+		$purge = $wgRequest->getVal( 'action' ) === 'purge';
+		// Allow users with 'purge' right to clear feed caches
+		if ( $purge && $wgUser->isAllowed( 'purge' ) ) {
+			$cache = ObjectCache::getMainWANInstance();
+			$cache->delete( $timekey, 1 );
+			$cache->delete( $key, 1 );
+		}
+	}
+
+	/**
+	 * Check whether feeds can be used and that $type is a valid feed type
+	 *
+	 * @param string $type Feed type, as requested by the user
+	 * @return bool
+	 */
+	public static function checkFeedOutput( $type ) {
+		global $wgOut, $wgFeed, $wgFeedClasses;
+
+		if ( !$wgFeed ) {
+			$wgOut->addWikiMsg( 'feed-unavailable' );
+			return false;
+		}
+
+		if ( !isset( $wgFeedClasses[$type] ) ) {
+			$wgOut->addWikiMsg( 'feed-invalid' );
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Format a diff for the newsfeed
+	 *
+	 * @param object $row Row from the recentchanges table, including fields as
+	 *  appropriate for CommentStore
+	 * @return string
+	 */
+	public static function formatDiff( $row ) {
+		$titleObj = Title::makeTitle( $row->rc_namespace, $row->rc_title );
+		$timestamp = wfTimestamp( TS_MW, $row->rc_timestamp );
+		$actiontext = '';
+		if ( $row->rc_type == RC_LOG ) {
+			$rcRow = (array)$row; // newFromRow() only accepts arrays for RC rows
+			$actiontext = LogFormatter::newFromRow( $rcRow )->getActionText();
+		}
+		return self::formatDiffRow( $titleObj,
+			$row->rc_last_oldid, $row->rc_this_oldid,
+			$timestamp,
+			$row->rc_deleted & Revision::DELETED_COMMENT
+				? wfMessage( 'rev-deleted-comment' )->escaped()
+				: CommentStore::getStore()->getComment( 'rc_comment', $row )->text,
+			$actiontext
+		);
+	}
+
+	/**
+	 * Really format a diff for the newsfeed
+	 *
+	 * @param Title $title
+	 * @param int $oldid Old revision's id
+	 * @param int $newid New revision's id
+	 * @param int $timestamp New revision's timestamp
+	 * @param string $comment New revision's comment
+	 * @param string $actiontext Text of the action; in case of log event
+	 * @return string
+	 */
+	public static function formatDiffRow( $title, $oldid, $newid, $timestamp,
+		$comment, $actiontext = ''
+	) {
+		global $wgFeedDiffCutoff, $wgLang;
+
+		// log entries
+		$completeText = '<p>' . implode( ' ',
+			array_filter(
+				[
+					$actiontext,
+					Linker::formatComment( $comment ) ] ) ) . "</p>\n";
+
+		// NOTE: Check permissions for anonymous users, not current user.
+		//       No "privileged" version should end up in the cache.
+		//       Most feed readers will not log in anyway.
+		$anon = new User();
+		$accErrors = $title->getUserPermissionsErrors( 'read', $anon, true );
+
+		// Can't diff special pages, unreadable pages or pages with no new revision
+		// to compare against: just return the text.
+		if ( $title->getNamespace() < 0 || $accErrors || !$newid ) {
+			return $completeText;
+		}
+
+		if ( $oldid ) {
+			$diffText = '';
+			// Don't bother generating the diff if we won't be able to show it
+			if ( $wgFeedDiffCutoff > 0 ) {
+				$rev = Revision::newFromId( $oldid );
+
+				if ( !$rev ) {
+					$diffText = false;
+				} else {
+					$context = clone RequestContext::getMain();
+					$context->setTitle( $title );
+
+					$contentHandler = $rev->getContentHandler();
+					$de = $contentHandler->createDifferenceEngine( $context, $oldid, $newid );
+					$diffText = $de->getDiff(
+						wfMessage( 'previousrevision' )->text(), // hack
+						wfMessage( 'revisionasof',
+							$wgLang->timeanddate( $timestamp ),
+							$wgLang->date( $timestamp ),
+							$wgLang->time( $timestamp ) )->text() );
+				}
+			}
+
+			if ( $wgFeedDiffCutoff <= 0 || ( strlen( $diffText ) > $wgFeedDiffCutoff ) ) {
+				// Omit large diffs
+				$diffText = self::getDiffLink( $title, $newid, $oldid );
+			} elseif ( $diffText === false ) {
+				// Error in diff engine, probably a missing revision
+				$diffText = "<p>Can't load revision $newid</p>";
+			} else {
+				// Diff output fine, clean up any illegal UTF-8
+				$diffText = UtfNormal\Validator::cleanUp( $diffText );
+				$diffText = self::applyDiffStyle( $diffText );
+			}
+		} else {
+			$rev = Revision::newFromId( $newid );
+			if ( $wgFeedDiffCutoff <= 0 || is_null( $rev ) ) {
+				$newContent = ContentHandler::getForTitle( $title )->makeEmptyContent();
+			} else {
+				$newContent = $rev->getContent();
+			}
+
+			if ( $newContent instanceof TextContent ) {
+				// only textual content has a "source view".
+				$text = $newContent->getNativeData();
+
+				if ( $wgFeedDiffCutoff <= 0 || strlen( $text ) > $wgFeedDiffCutoff ) {
+					$html = null;
+				} else {
+					$html = nl2br( htmlspecialchars( $text ) );
+				}
+			} else {
+				// XXX: we could get an HTML representation of the content via getParserOutput, but that may
+				//     contain JS magic and generally may not be suitable for inclusion in a feed.
+				//     Perhaps Content should have a getDescriptiveHtml method and/or a getSourceText method.
+				// Compare also ApiFeedContributions::feedItemDesc
+				$html = null;
+			}
+
+			if ( $html === null ) {
+				// Omit large new page diffs, T31110
+				// Also use diff link for non-textual content
+				$diffText = self::getDiffLink( $title, $newid );
+			} else {
+				$diffText = '<p><b>' . wfMessage( 'newpage' )->text() . '</b></p>' .
+					'<div>' . $html . '</div>';
+			}
+		}
+		$completeText .= $diffText;
+
+		return $completeText;
+	}
+
+	/**
+	 * Generates a diff link. Used when the full diff is not wanted for example
+	 * when $wgFeedDiffCutoff is 0.
+	 *
+	 * @param Title $title Title object: used to generate the diff URL
+	 * @param int $newid Newid for this diff
+	 * @param int|null $oldid Oldid for the diff. Null means it is a new article
+	 * @return string
+	 */
+	protected static function getDiffLink( Title $title, $newid, $oldid = null ) {
+		$queryParameters = [ 'diff' => $newid ];
+		if ( $oldid != null ) {
+			$queryParameters['oldid'] = $oldid;
+		}
+		$diffUrl = $title->getFullURL( $queryParameters );
+
+		$diffLink = Html::element( 'a', [ 'href' => $diffUrl ],
+			wfMessage( 'showdiff' )->inContentLanguage()->text() );
+
+		return $diffLink;
+	}
+
+	/**
+	 * Hacky application of diff styles for the feeds.
+	 * Might be 'cleaner' to use DOM or XSLT or something,
+	 * but *gack* it's a pain in the ass.
+	 *
+	 * @param string $text Diff's HTML output
+	 * @return string Modified HTML
+	 */
+	public static function applyDiffStyle( $text ) {
+		$styles = [
+			'diff'             => 'background-color: #fff; color: #222;',
+			'diff-otitle'      => 'background-color: #fff; color: #222; text-align: center;',
+			'diff-ntitle'      => 'background-color: #fff; color: #222; text-align: center;',
+			'diff-addedline'   => 'color: #222; font-size: 88%; border-style: solid; '
+				. 'border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; '
+				. 'vertical-align: top; white-space: pre-wrap;',
+			'diff-deletedline' => 'color: #222; font-size: 88%; border-style: solid; '
+				. 'border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; '
+				. 'vertical-align: top; white-space: pre-wrap;',
+			'diff-context'     => 'background-color: #f8f9fa; color: #222; font-size: 88%; '
+				. 'border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; '
+				. 'border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;',
+			'diffchange'       => 'font-weight: bold; text-decoration: none;',
+		];
+
+		foreach ( $styles as $class => $style ) {
+			$text = preg_replace( "/(<[^>]+)class=(['\"])$class\\2([^>]*>)/",
+				"\\1style=\"$style\"\\3", $text );
+		}
+
+		return $text;
+	}
+
+}