Diffusion extension-Collection (master) Browse

rECOL/Collection.php
8f0198affa9amaster

Collection.php
View Options

			<?php

			/**
			* Collection Extension for MediaWiki
			*
			* Copyright (C) PediaPress GmbH
			*
			* 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
			*/

			# Not a valid entry point, skip unless MEDIAWIKI is defined
			if ( !defined( 'MEDIAWIKI' ) ) {
			echo <<<EOT
			To install the Collection extension, put the following line in LocalSettings.php:
			require_once( "\$IP/extensions/Collection/Collection.php" );
			EOT;
			exit( 1 );
			}

			$wgExtensionCredits['specialpage'][] = array(
			'path' => __FILE__,
			'name' => 'Collection',
			'version' => '1.7.0',
			'author' => array( 'PediaPress GmbH', 'Siebrand Mazeland', 'Marcin Cieślak'),
			'url' => 'https://www.mediawiki.org/wiki/Extension:Collection',
			'descriptionmsg' => 'coll-desc',
			);

			$dir = __DIR__ . '/';

			# ==============================================================================

			# Configuration:

			/** Bump the version number every time you change any of the JavaScript files */
			$wgCollectionStyleVersion = 9;

			/** URL of mw-serve render server */
			$wgCollectionMWServeURL = 'http://tools.pediapress.com/mw-serve/';

			/** Login credentials to this MediaWiki as 'USERNAME:PASSWORD' string */
			$wgCollectionMWServeCredentials = null;

			/** PEM-encoded SSL certificate for the mw-serve render server to pass to CURL */
			$wgCollectionMWServeCert = null;

			/** if not null, treat this string as hierarchy delimiter in page titles,
			* i.e. support subpages */
			$wgCollectionHierarchyDelimiter = null;

			/** Array of namespaces that can be added to a collection */
			$wgCollectionArticleNamespaces = array(
			NS_MAIN,
			NS_TALK,
			NS_USER,
			NS_USER_TALK,
			NS_PROJECT,
			NS_PROJECT_TALK,
			NS_MEDIAWIKI,
			NS_MEDIAWIKI_TALK,
			100,
			101,
			102,
			103,
			104,
			105,
			106,
			107,
			108,
			109,
			110,
			111,
			);

			/** Namespace for "community books" */
			$wgCommunityCollectionNamespace = NS_PROJECT;

			/** Maximum no. of articles in a book */
			$wgCollectionMaxArticles = 500;

			/** Name of license */
			$wgCollectionLicenseName = null;

			/** HTTP(s) URL pointing to license in wikitext format: */
			$wgCollectionLicenseURL = null;

			/** List of available download formats,
			as mapping of mwlib writer to format name */
			$wgCollectionFormats = array(
			'rl' => 'PDF',
			#'zeno' => 'ZENO',
			#'okawix_zeno' => 'Okawix (ZENO + search engine)',
			);

			/** Additional renderer options for collections. Format is as for
			* HTMLForm::loadInputFromParameters. Note that fieldnames may only contain
			* [a-zA-Z0-9_-], and values may not contain pipes or newlines. If the
			* 'options' field is an array, keys will be interpreted as messages.
			*/
			$wgCollectionRendererSettings = array(
			'papersize' => array(
			'type' => 'select',
			'label-message' => 'coll-setting-papersize',
			'default' => 'A4',
			'options' => array(
			'coll-setting-papersize-a4' => 'A4',
			'coll-setting-papersize-letter' => 'Letter',
			),
			),
			'showtoc' => array(
			'type' => 'check',
			'label-message' => 'coll-setting-showtoc',
			'default' => true,
			),
			'columns' => array(
			'type' => 'select',
			'label-message' => 'coll-setting-columns',
			'default' => 1,
			'options' => array(
			'coll-setting-columns-1' => '1',
			'coll-setting-columns-2' => '2',
			),
			),
			);

			/** For formats which rendering depends on an external server
			*/
			$wgCollectionFormatToServeURL = array(
			'zeno' => 'http://www.okawix.com/collections/render.php',
			'okawix_zeno' => 'http://www.okawix.com/collections/render.php',
			);

			$wgCollectionContentTypeToFilename = array(
			'application/pdf' => 'collection.pdf',
			'application/vnd.oasis.opendocument.text' => 'collection.odt',
			);

			$wgCollectionPortletFormats = array( 'rl' );

			$wgCollectionPortletForLoggedInUsersOnly = false;

			$wgCollectionMaxSuggestions = 10;

			$wgCollectionSuggestCheapWeightThreshhold = 50;

			$wgCollectionSuggestThreshhold = 100;

			$wgCollectionPODPartners = array(
			'pediapress' => array(
			'name' => 'PediaPress',
			'url' => 'http://pediapress.com/',
			'posturl' => 'http://pediapress.com/api/collections/',
			'infopagetitle' => 'coll-order_info_article',
			),
			);
			# ==============================================================================

			# register Special:Book:
			$wgAutoloadClasses['SpecialCollection'] = $dir . 'Collection.body.php';
			$wgAutoloadClasses['CollectionSession'] = $dir . 'Collection.session.php';
			$wgAutoloadClasses['CollectionHooks'] = $dir . 'Collection.hooks.php';
			$wgAutoloadClasses['CollectionSuggest'] = $dir . 'Collection.suggest.php';
			$wgAutoloadClasses['CollectionPageTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionListTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionLoadOverwriteTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionSaveOverwriteTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionRenderingTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionFinishedTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionFailedTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionSuggestTemplate'] = $dir . 'Collection.templates.php';
			$wgAutoloadClasses['CollectionRenderingAPI'] = $dir . 'RenderingAPI.php';
			$wgAutoloadClasses['MWServeRenderingAPI'] = $dir . 'RenderingAPI.php';
			$wgAutoloadClasses['CollectionAPIResult'] = $dir . 'RenderingAPI.php';

			$wgMessagesDirs['Collection'] = __DIR__ . '/i18n';
			$wgExtensionMessagesFiles['Collection'] = $dir . 'Collection.i18n.php';
			$wgExtensionMessagesFiles['CollectionAlias'] = $dir . 'Collection.alias.php';

			$wgSpecialPages['Book'] = 'SpecialCollection';
			$wgSpecialPageGroups['Book'] = 'pagetools';

			$wgHooks['SkinTemplateBuildNavUrlsNav_urlsAfterPermalink'][] = 'CollectionHooks::buildNavUrls';
			$wgHooks['SkinBuildSidebar'][] = 'CollectionHooks::buildSidebar';
			$wgHooks['SiteNoticeAfter'][] = 'CollectionHooks::siteNoticeAfter';
			$wgHooks['OutputPageCheckLastModified'][] = 'CollectionHooks::checkLastModified';

			$wgAvailableRights[] = 'collectionsaveasuserpage';
			$wgAvailableRights[] = 'collectionsaveascommunitypage';

			$collResourceTemplate = array(
			'localBasePath' => "$dir/js",
			'remoteExtPath' => 'Collection/js'
			);

			$wgResourceModules += array(
			'ext.collection.jquery.jstorage' => $collResourceTemplate + array(
			'scripts' => 'jstorage.js',
			'dependencies' => 'jquery.json'
			),
			'ext.collection.suggest' => $collResourceTemplate + array(
			'scripts' => 'suggest.js',
			'dependencies' => 'ext.collection.bookcreator'
			),
			'ext.collection' => $collResourceTemplate + array(
			'scripts' => 'collection.js',
			'dependencies' => array(
			'ext.collection.bookcreator',
			'jquery.ui.sortable',
			'mediawiki.language',
			),
			),
			'ext.collection.bookcreator' => $collResourceTemplate + array(
			'scripts' => 'bookcreator.js',
			'styles' => 'bookcreator.css',
			'dependencies' => 'ext.collection.jquery.jstorage'
			),
			'ext.collection.checkLoadFromLocalStorage' => $collResourceTemplate + array(
			'scripts' => 'check_load_from_localstorage.js',
			'styles' => 'bookcreator.css',
			'dependencies' => 'ext.collection.jquery.jstorage'
			)
			);

			# register global Ajax functions:

			function wfAjaxGetCollection() {
			if ( isset( $_SESSION['wsCollection'] ) ) {
			$collection = $_SESSION['wsCollection'];
			} else {
			$collection = array();
			}
			$r = new AjaxResponse( FormatJson::encode( array( 'collection' => $collection ) ) );
			$r->setContentType( 'application/json' );
			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxGetCollection';

			function wfAjaxPostCollection( $collection = '', $redirect = '' ) {
			if ( session_id() == '' ) {
			wfSetupSession();
			}
			$collection = FormatJson::decode( $collection, true );
			$collection['enabled'] = true;
			$_SESSION['wsCollection'] = $collection;
			$r = new AjaxResponse();
			if ( $redirect ) {
			$title = Title::newFromText( $redirect );
			$redirecturl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
			$r->setResponseCode( 302 );
			header( 'Location: ' . $redirecturl );
			} else {
			$title = SpecialPage::getTitleFor( 'Book' );
			$redirecturl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
			$r->setContentType( 'application/json' );
			$r->addText( FormatJson::encode( array( 'redirect_url' => $redirecturl ) ) );
			}
			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxPostCollection';

			function wfAjaxGetMWServeStatus( $collection_id = '', $writer = 'rl' ) {
			$response = CollectionRenderingAPI::instance( $writer )->getRenderStatus( $collection_id, $writer );
			$result = $response->response;
			if ( isset( $result['status']['progress'] ) ) {
			$result['status']['progress'] = number_format( $result['status']['progress'], 2, '.', '' );
			}
			$r = new AjaxResponse( FormatJson::encode( $result ) );
			$r->setContentType( 'application/json' );
			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxGetMWServeStatus';

			function wfAjaxCollectionAddArticle( $namespace = 0, $title = '', $oldid = '' ) {
			SpecialCollection::addArticleFromName( $namespace, $title, $oldid );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionAddArticle';

			function wfAjaxCollectionRemoveArticle( $namespace = 0, $title = '', $oldid = '' ) {
			SpecialCollection::removeArticleFromName( $namespace, $title, $oldid );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionRemoveArticle';

			function wfAjaxCollectionAddCategory( $title = '' ) {
			SpecialCollection::addCategoryFromName( $title );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionAddCategory';

			function wfAjaxCollectionGetBookCreatorBoxContent( $ajaxHint = '', $oldid = null, $pageName = null ) {
			if ( !is_null( $oldid ) ) {
			$oldid = intval( $oldid );
			}

			$title = null;
			if ( !is_null( $pageName ) ) {
			$title = Title::newFromText( $pageName );
			}
			if ( is_null( $title ) ) {
			$title = Title::newMainPage();
			}

			$html = CollectionHooks::getBookCreatorBoxContent( $title, $ajaxHint, $oldid );

			$result = array();
			$result['html'] = $html;
			$r = new AjaxResponse( FormatJson::encode( $result ) );
			$r->setContentType( 'application/json' );
			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionGetBookCreatorBoxContent';

			function wfAjaxCollectionGetItemList() {
			$collection = $_SESSION['wsCollection'];

			$template = new CollectionListTemplate();
			$template->set( 'collection', $collection );
			$template->set( 'is_ajax', true );
			ob_start();
			$template->execute();
			$html = ob_get_contents();
			ob_end_clean();

			$result = array();
			$result['html'] = $html;
			$result['collection'] = $collection;
			$r = new AjaxResponse( FormatJson::encode( $result ) );
			$r->setContentType( 'application/json' );
			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionGetItemList';

			function wfAjaxCollectionRemoveItem( $index ) {
			SpecialCollection::removeItem( (int)$index );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionRemoveItem';

			function wfAjaxCollectionAddChapter( $name ) {
			SpecialCollection::addChapter( $name );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionAddChapter';

			function wfAjaxCollectionRenameChapter( $index, $name ) {
			SpecialCollection::renameChapter( (int)$index, $name );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionRenameChapter';

			function wfAjaxCollectionSetTitles( $title, $subtitle, $settings = '' ) {
			SpecialCollection::setTitles( $title, $subtitle );
			$settings = FormatJson::decode( $settings, true );
			if ( is_array( $settings ) ) {
			SpecialCollection::setSettings( $settings );
			}
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionSetTitles';

			function wfAjaxCollectionSetSorting( $items_string ) {
			$parsed = array();
			parse_str( $items_string, $parsed );
			$items = array();
			foreach ( $parsed['item'] as $s ) {
			if ( is_numeric( $s ) ) {
			$items[] = intval( $s );
			}
			}
			SpecialCollection::setSorting( $items );
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionSetSorting';

			function wfAjaxCollectionClear() {
			CollectionSession::clearCollection();
			CollectionSuggest::clear();
			return wfAjaxCollectionGetItemList();
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionClear';

			function wfAjaxCollectionGetPopupData( $title ) {
			global $wgExtensionAssetsPath;

			$result = array();
			$imagePath = "$wgExtensionAssetsPath/Collection/images";
			$t = Title::newFromText( $title );
			if ( $t && $t->isRedirect() ) {
			$wikiPage = WikiPage::factory( $t );
			$t = $wikiPage->followRedirect();
			if ( $t instanceof Title ) {
			$title = $t->getPrefixedText();
			}
			}
			if ( CollectionSession::findArticle( $title ) == - 1 ) {
			$result['action'] = 'add';
			$result['text'] = wfMessage( 'coll-add_linked_article' )->text();
			$result['img'] = "$imagePath/silk-add.png";
			} else {
			$result['action'] = 'remove';
			$result['text'] = wfMessage( 'coll-remove_linked_article' )->text();
			$result['img'] = "$imagePath/silk-remove.png";
			}
			$result['title'] = $title;
			$r = new AjaxResponse( FormatJson::encode( $result ) );
			$r->setContentType( 'application/json' );

			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionGetPopupData';

			/**
			* Backend of several following SAJAX function handlers...
			* @param String $action provided by the specific handlers internally
			* @param String $article title passed in from client
			* @return AjaxResponse with JSON-encoded array including HTML fragment.
			*/
			function wfCollectionSuggestAction( $action, $article ) {
			$result = CollectionSuggest::refresh( $action, $article );
			$undoLink = Xml::element( 'a',
			array(
			'href' => SkinTemplate::makeSpecialUrl(
			'Book',
			array( 'bookcmd' => 'suggest', 'undo' => $action, 'arttitle' => $article )
			),
			'onclick' => "collectionSuggestCall('UndoArticle'," .
			Xml::encodeJsVar( array( $action, $article ) ) . "); return false;",
			'title' => wfMessage( 'coll-suggest_undo_tooltip' )->text(),
			),
			wfMessage( 'coll-suggest_undo' )->text()
			);
			// Message keys used: coll-suggest_article_ban, coll-suggest_article_add, coll-suggest_article_remove
			$result['last_action'] = wfMessage( "coll-suggest_article_$action", $article )
			->rawParams( $undoLink )->parse();
			$result['collection'] = CollectionSession::getCollection();
			$r = new AjaxResponse( FormatJson::encode( $result ) );
			$r->setContentType( 'application/json' );
			return $r;
			}

			function wfAjaxCollectionSuggestBanArticle( $article ) {
			return wfCollectionSuggestAction( 'ban', $article );
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionSuggestBanArticle';

			function wfAjaxCollectionSuggestAddArticle( $article ) {
			return wfCollectionSuggestAction( 'add', $article );
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionSuggestAddArticle';

			function wfAjaxCollectionSuggestRemoveArticle( $article ) {
			return wfCollectionSuggestAction( 'remove', $article );
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionSuggestRemoveArticle';

			function wfAjaxCollectionSuggestUndoArticle( $lastAction, $article ) {
			$result = CollectionSuggest::undo( $lastAction, $article );
			$r = new AjaxResponse( FormatJson::encode( $result ) );
			$r->setContentType( 'application/json' );
			return $r;
			}

			$wgAjaxExportList[] = 'wfAjaxCollectionSuggestUndoArticle';

rECOL/Collection.php8f0198affa9amaster

Collection.phpView Options

rECOL/Collection.php
8f0198affa9amaster

Collection.php
View Options