Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 9 |
CRAP | |
0.00% |
0 / 196 |
| CollectionHooks | |
0.00% |
0 / 1 |
|
0.00% |
0 / 9 |
2450 | |
0.00% |
0 / 196 |
| onSidebarBeforeOutput | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 6 |
|||
| getPortlet | |
0.00% |
0 / 1 |
210 | |
0.00% |
0 / 44 |
|||
| siteNoticeAfter | |
0.00% |
0 / 1 |
182 | |
0.00% |
0 / 25 |
|||
| renderBookCreatorBox | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 21 |
|||
| getBookCreatorBoxContent | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 4 |
|||
| getBookCreatorBoxAddRemoveLink | |
0.00% |
0 / 1 |
72 | |
0.00% |
0 / 46 |
|||
| getBookCreatorBoxShowBookLink | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 22 |
|||
| getBookCreatorBoxSuggestLink | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 24 |
|||
| checkLastModified | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 4 |
|||
| <?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 | |
| */ | |
| use MediaWiki\Session\SessionManager; | |
| class CollectionHooks { | |
| /** | |
| * Callback for SidebarBeforeOutput hook | |
| * | |
| * @param Skin $skin | |
| * @param array &$sidebar | |
| */ | |
| public static function onSidebarBeforeOutput( Skin $skin, &$sidebar ) { | |
| global $wgCollectionPortletForLoggedInUsersOnly; | |
| if ( !$wgCollectionPortletForLoggedInUsersOnly || $skin->getUser()->isRegistered() ) { | |
| $portlet = self::getPortlet( $skin ); | |
| if ( $portlet ) { | |
| // Unset 'print' item. We have moved it to our own section. | |
| unset( $sidebar['TOOLBOX']['print'] ); | |
| // Add our section | |
| $sidebar[ 'coll-print_export' ] = $portlet; | |
| } | |
| } | |
| } | |
| /** | |
| * Return HTML-code to be inserted as portlet | |
| * | |
| * @param Skin $sk | |
| * | |
| * @return array[]|false | |
| */ | |
| public static function getPortlet( $sk ) { | |
| global $wgCollectionArticleNamespaces; | |
| global $wgCollectionFormats; | |
| global $wgCollectionPortletFormats; | |
| $title = $sk->getTitle(); | |
| if ( $title === null || !$title->exists() ) { | |
| return false; | |
| } | |
| $namespace = $title->getNamespace(); | |
| if ( !in_array( $namespace, $wgCollectionArticleNamespaces ) | |
| && $namespace != NS_CATEGORY ) { | |
| return false; | |
| } | |
| $action = $sk->getRequest()->getVal( 'action', 'view' ); | |
| if ( $action != 'view' && $action != 'purge' ) { | |
| return false; | |
| } | |
| $out = []; | |
| $booktitle = SpecialPage::getTitleFor( 'Book' ); | |
| if ( !CollectionSession::isEnabled() ) { | |
| if ( !$sk->getConfig()->get( 'CollectionDisableSidebarLink' ) ) { | |
| $out[] = [ | |
| 'text' => $sk->msg( 'coll-create_a_book' )->escaped(), | |
| 'id' => 'coll-create_a_book', | |
| 'href' => $booktitle->getLocalURL( | |
| [ 'bookcmd' => 'book_creator', 'referer' => $title->getPrefixedText() ] | |
| ), | |
| ]; | |
| } | |
| } else { | |
| $out[] = [ | |
| 'text' => $sk->msg( 'coll-book_creator_disable' )->escaped(), | |
| 'id' => 'coll-book_creator_disable', | |
| 'href' => $booktitle->getLocalURL( | |
| [ | |
| 'bookcmd' => 'stop_book_creator', | |
| 'referer' => $title->getPrefixedText(), | |
| ] | |
| ), | |
| ]; | |
| } | |
| $params = [ | |
| 'bookcmd' => 'render_article', | |
| 'arttitle' => $title->getPrefixedText(), | |
| 'returnto' => $title->getPrefixedText(), | |
| ]; | |
| $oldid = $sk->getRequest()->getVal( 'oldid' ); | |
| if ( $oldid ) { | |
| $params['oldid'] = $oldid; | |
| } else { | |
| $params['oldid'] = $title->getLatestRevID(); | |
| } | |
| foreach ( $wgCollectionPortletFormats as $writer ) { | |
| $params['writer'] = $writer; | |
| $out[] = [ | |
| 'text' => $sk->msg( 'coll-download_as', $wgCollectionFormats[$writer] )->escaped(), | |
| 'id' => 'coll-download-as-' . $writer, | |
| 'href' => $booktitle->getLocalURL( $params ), | |
| ]; | |
| } | |
| // Move the 'printable' link into our section for consistency | |
| if ( $action == 'view' || $action == 'purge' ) { | |
| if ( !$sk->getOutput()->isPrintable() ) { | |
| $out[] = [ 'text' => $sk->msg( 'printableversion' )->text(), | |
| 'id' => 't-print', | |
| 'href' => $title->getLocalURL( [ 'printable' => 'yes' ] ) | |
| ]; | |
| } | |
| } | |
| return $out; | |
| } | |
| /** | |
| * Callback for hook SiteNoticeAfter | |
| * @param string &$siteNotice | |
| * @param Skin $skin | |
| * @return bool | |
| */ | |
| public static function siteNoticeAfter( &$siteNotice, $skin ) { | |
| global $wgCollectionArticleNamespaces; | |
| $request = $skin->getRequest(); | |
| $title = $skin->getTitle(); | |
| $action = $request->getVal( 'action' ); | |
| if ( $action != '' && $action != 'view' && $action != 'purge' ) { | |
| return true; | |
| } | |
| $session = SessionManager::getGlobalSession(); | |
| if ( | |
| !isset( $session['wsCollection'] ) || | |
| !isset( $session['wsCollection']['enabled'] ) || | |
| !$session['wsCollection']['enabled'] | |
| ) { | |
| return true; | |
| } | |
| if ( $title->isSpecial( 'Book' ) ) { | |
| $cmd = $request->getVal( 'bookcmd', '' ); | |
| if ( $cmd == 'suggest' ) { | |
| $siteNotice .= self::renderBookCreatorBox( $title, 'suggest' ); | |
| } elseif ( $cmd == '' ) { | |
| $siteNotice .= self::renderBookCreatorBox( $title, 'showbook' ); | |
| } | |
| return true; | |
| } | |
| if ( !$title->exists() ) { | |
| return true; | |
| } | |
| $namespace = $title->getNamespace(); | |
| if ( !in_array( $namespace, $wgCollectionArticleNamespaces ) | |
| && $namespace != NS_CATEGORY ) { | |
| return true; | |
| } | |
| $siteNotice .= self::renderBookCreatorBox( $title ); | |
| return true; | |
| } | |
| /** | |
| * @param Title $title | |
| * @param string $mode | |
| * @return string | |
| */ | |
| public static function renderBookCreatorBox( Title $title, $mode = '' ) { | |
| global $wgOut, $wgExtensionAssetsPath, $wgRequest; | |
| $templateParser = new TemplateParser( dirname( __DIR__ ) . '/templates' ); | |
| $imagePath = "$wgExtensionAssetsPath/Collection/images"; | |
| $ptext = $title->getPrefixedText(); | |
| $oldid = $wgRequest->getInt( 'oldid', 0 ); | |
| if ( $oldid == $title->getLatestRevID() ) { | |
| $oldid = 0; | |
| } | |
| $wgOut->addModules( 'ext.collection.bookcreator' ); | |
| $wgOut->addModuleStyles( 'ext.collection.bookcreator.styles' ); | |
| $addRemoveState = $mode; | |
| return $templateParser->processTemplate( 'create-book', [ | |
| "actionsHtml" => self::getBookCreatorBoxContent( $title, $addRemoveState, $oldid ), | |
| "imagePath" => $imagePath, | |
| "title" => wfMessage( 'coll-book_creator' )->text(), | |
| "disable" => [ | |
| "url" => SpecialPage::getTitleFor( 'Book' )->getLocalUrl( | |
| [ 'bookcmd' => 'stop_book_creator', 'referer' => $ptext ] | |
| ), | |
| "title" => wfMessage( 'coll-book_creator_disable_tooltip' )->text(), | |
| "label" => wfMessage( 'coll-disable' )->escaped(), | |
| ], | |
| "help" => [ | |
| "url" => Title::newFromText( wfMessage( 'coll-helppage' )->text() )->getLocalUrl(), | |
| "label" => wfMessage( 'coll-help' )->escaped(), | |
| "title" => wfMessage( 'coll-help_tooltip' )->text(), | |
| "icon" => $imagePath . '/silk-help.png', | |
| ] | |
| ] ); | |
| } | |
| /** | |
| * @param Title $title | |
| * @param string|null $hint Defaults to null | |
| * @param null|int $oldid | |
| * @return string | |
| */ | |
| public static function getBookCreatorBoxContent( Title $title, $hint = null, $oldid = null ) { | |
| global $wgExtensionAssetsPath; | |
| $imagePath = "$wgExtensionAssetsPath/Collection/images"; | |
| return self::getBookCreatorBoxAddRemoveLink( $imagePath, $hint, $title, $oldid ) | |
| . self::getBookCreatorBoxShowBookLink( $imagePath, $hint ) | |
| . self::getBookCreatorBoxSuggestLink( $imagePath, $hint ); | |
| } | |
| /** | |
| * @param string $imagePath | |
| * @param string $hint | |
| * @param Title $title | |
| * @param int $oldid | |
| * @return string | |
| */ | |
| public static function getBookCreatorBoxAddRemoveLink( | |
| $imagePath, | |
| $hint, | |
| Title $title, | |
| $oldid | |
| ) { | |
| $namespace = $title->getNamespace(); | |
| $ptext = $title->getPrefixedText(); | |
| if ( $hint == 'suggest' || $hint == 'showbook' ) { | |
| return Xml::tags( 'span', | |
| [ 'style' => 'color: #777;' ], | |
| Xml::element( 'img', | |
| [ | |
| 'src' => "$imagePath/disabled.png", | |
| 'alt' => '', | |
| 'width' => '16', | |
| 'height' => '16', | |
| 'style' => 'vertical-align: text-bottom', | |
| ] | |
| ) | |
| . ' ' . wfMessage( 'coll-not_addable' )->escaped() | |
| ); | |
| } | |
| if ( $hint == 'addcategory' || $namespace == NS_CATEGORY ) { | |
| $id = 'coll-add_category'; | |
| $icon = 'silk-add.png'; | |
| $captionMsg = 'coll-add_category'; | |
| $tooltipMsg = 'coll-add_category_tooltip'; | |
| $query = [ 'bookcmd' => 'add_category', 'cattitle' => $title->getText() ]; | |
| $onclick = "collectionCall('addcategory', mw.config.get('wgNamespaceNumber')," . | |
| "mw.config.get('wgTitle')]); return false;"; | |
| } else { | |
| $collectionArgsJs = "mw.config.get('wgNamespaceNumber'), mw.config.get('wgTitle'), " . | |
| Xml::encodeJsVar( $oldid ); | |
| if ( $hint == 'addarticle' | |
| || ( $hint == '' && CollectionSession::findArticle( $ptext, $oldid ) == -1 ) ) { | |
| $id = 'coll-add_article'; | |
| $icon = 'silk-add.png'; | |
| $captionMsg = 'coll-add_this_page'; | |
| $tooltipMsg = 'coll-add_page_tooltip'; | |
| $query = [ 'bookcmd' => 'add_article', 'arttitle' => $ptext, 'oldid' => $oldid ]; | |
| $onclick = "collectionCall('addarticle', " . $collectionArgsJs . "); return false;"; | |
| } else { | |
| $id = 'coll-remove_article'; | |
| $icon = 'silk-remove.png'; | |
| $captionMsg = 'coll-remove_this_page'; | |
| $tooltipMsg = 'coll-remove_page_tooltip'; | |
| $query = [ 'bookcmd' => 'remove_article', 'arttitle' => $ptext, 'oldid' => $oldid ]; | |
| $onclick = "collectionCall('removearticle', " . $collectionArgsJs . "); return false;"; | |
| } | |
| } | |
| return Linker::linkKnown( | |
| SpecialPage::getTitleFor( 'Book' ), | |
| Xml::element( 'img', | |
| [ | |
| 'src' => "$imagePath/$icon", | |
| 'alt' => '', | |
| 'width' => '16', | |
| 'height' => '16', | |
| ] | |
| ) | |
| . ' ' . wfMessage( $captionMsg )->escaped(), | |
| [ | |
| 'id' => $id, | |
| 'rel' => 'nofollow', | |
| 'title' => wfMessage( $tooltipMsg )->text(), | |
| 'onclick' => $onclick, | |
| ], | |
| $query | |
| ); | |
| } | |
| /** | |
| * @param string $imagePath | |
| * @param string $hint | |
| * @return string | |
| */ | |
| public static function getBookCreatorBoxShowBookLink( $imagePath, $hint ) { | |
| $numArticles = CollectionSession::countArticles(); | |
| if ( $hint == 'showbook' ) { | |
| return Xml::tags( 'strong', | |
| [ | |
| 'class' => 'collection-creatorbox-iconlink', | |
| ], | |
| Xml::element( 'img', | |
| [ | |
| 'src' => "$imagePath/silk-book_open.png", | |
| 'alt' => '', | |
| 'width' => '16', | |
| 'height' => '16', | |
| ] | |
| ) | |
| . ' ' . wfMessage( 'coll-show_collection' )->escaped() | |
| . ' (' . wfMessage( 'coll-n_pages' )->numParams( $numArticles )->escaped() . ')' | |
| ); // @todo FIXME: Hard coded parentheses. | |
| } else { | |
| return Linker::linkKnown( | |
| SpecialPage::getTitleFor( 'Book' ), | |
| Xml::element( 'img', | |
| [ | |
| 'src' => "$imagePath/silk-book_open.png", | |
| 'alt' => '', | |
| 'width' => '16', | |
| 'height' => '16', | |
| ] | |
| ) | |
| . ' ' . wfMessage( 'coll-show_collection' )->escaped() | |
| . ' (' . wfMessage( 'coll-n_pages' )->numParams( $numArticles )->escaped() . ')', | |
| [ | |
| 'rel' => 'nofollow', | |
| 'title' => wfMessage( 'coll-show_collection_tooltip' )->text(), | |
| 'class' => 'collection-creatorbox-iconlink', | |
| ] | |
| ); // @todo FIXME: Hard coded parentheses. | |
| } | |
| } | |
| /** | |
| * @param string $imagePath | |
| * @param string $hint | |
| * @return string | |
| */ | |
| public static function getBookCreatorBoxSuggestLink( $imagePath, $hint ) { | |
| if ( wfMessage( 'coll-suggest_enabled' )->escaped() != '1' ) { | |
| return ''; | |
| } | |
| if ( $hint == 'suggest' ) { | |
| return Xml::tags( 'strong', | |
| [ | |
| 'class' => 'collection-creatorbox-iconlink', | |
| ], | |
| Xml::element( 'img', | |
| [ | |
| 'src' => "$imagePath/silk-wand.png", | |
| 'alt' => '', | |
| 'width' => '16', | |
| 'height' => '16', | |
| 'style' => 'vertical-align: text-bottom', | |
| ] | |
| ) | |
| . ' ' . wfMessage( 'coll-make_suggestions' )->escaped() | |
| ); | |
| } else { | |
| return Linker::linkKnown( | |
| SpecialPage::getTitleFor( 'Book' ), | |
| Xml::element( 'img', | |
| [ | |
| 'src' => "$imagePath/silk-wand.png", | |
| 'alt' => '', | |
| 'width' => '16', | |
| 'height' => '16', | |
| 'style' => 'vertical-align: text-bottom', | |
| ] | |
| ) | |
| . ' ' . wfMessage( 'coll-make_suggestions' )->escaped(), | |
| [ | |
| 'rel' => 'nofollow', | |
| 'title' => wfMessage( 'coll-make_suggestions_tooltip' )->text(), | |
| 'class' => 'collection-creatorbox-iconlink', | |
| ], | |
| [ 'bookcmd' => 'suggest' ] | |
| ); | |
| } | |
| } | |
| /** | |
| * OutputPageCheckLastModified hook | |
| * @param array $modifiedTimes | |
| * @return bool | |
| */ | |
| public static function checkLastModified( $modifiedTimes ) { | |
| $session = SessionManager::getGlobalSession(); | |
| if ( isset( $session['wsCollection']['timestamp'] ) ) { | |
| $modifiedTimes['collection'] = $session['wsCollection']['timestamp']; | |
| } | |
| return true; | |
| } | |
| } |