1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2016 webtrees development team 5 * This program is free software: you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation, either version 3 of the License, or 8 * (at your option) any later version. 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * You should have received a copy of the GNU General Public License 14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 15 */ 16namespace Fisharebest\Webtrees\Module; 17 18use Fisharebest\Webtrees\Auth; 19use Fisharebest\Webtrees\Database; 20use Fisharebest\Webtrees\Filter; 21use Fisharebest\Webtrees\Functions\FunctionsEdit; 22use Fisharebest\Webtrees\GedcomRecord; 23use Fisharebest\Webtrees\I18N; 24use Fisharebest\Webtrees\Theme; 25 26/** 27 * Class TopPageViewsModule 28 */ 29class TopPageViewsModule extends AbstractModule implements ModuleBlockInterface { 30 /** 31 * How should this module be labelled on tabs, menus, etc.? 32 * 33 * @return string 34 */ 35 public function getTitle() { 36 return /* I18N: Name of a module */ I18N::translate('Most viewed pages'); 37 } 38 39 /** 40 * A sentence describing what this module does. 41 * 42 * @return string 43 */ 44 public function getDescription() { 45 return /* I18N: Description of the “Most visited pages” module */ I18N::translate('A list of the pages that have been viewed the most number of times.'); 46 } 47 48 /** 49 * Generate the HTML content of this block. 50 * 51 * @param int $block_id 52 * @param bool $template 53 * @param string[] $cfg 54 * 55 * @return string 56 */ 57 public function getBlock($block_id, $template = true, $cfg = []) { 58 global $ctype, $WT_TREE; 59 60 $num = $this->getBlockSetting($block_id, 'num', '10'); 61 $count_placement = $this->getBlockSetting($block_id, 'count_placement', 'before'); 62 63 foreach (['count_placement', 'num'] as $name) { 64 if (array_key_exists($name, $cfg)) { 65 $$name = $cfg[$name]; 66 } 67 } 68 69 $id = $this->getName() . $block_id; 70 $class = $this->getName() . '_block'; 71 if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) { 72 $title = '<a class="icon-admin" title="' . I18N::translate('Preferences') . '" href="block_edit.php?block_id=' . $block_id . '&ged=' . $WT_TREE->getNameHtml() . '&ctype=' . $ctype . '"></a>'; 73 } else { 74 $title = ''; 75 } 76 $title .= $this->getTitle(); 77 78 $content = ''; 79 // load the lines from the file 80 $top10 = Database::prepare( 81 "SELECT page_parameter, page_count" . 82 " FROM `##hit_counter`" . 83 " WHERE gedcom_id = :tree_id AND page_name IN ('individual.php','family.php','source.php','repo.php','note.php','mediaviewer.php')" . 84 " ORDER BY page_count DESC LIMIT :limit" 85 )->execute([ 86 'tree_id' => $WT_TREE->getTreeId(), 87 'limit' => (int) $num, 88 ])->fetchAssoc(); 89 90 $content .= '<table>'; 91 foreach ($top10 as $id => $count) { 92 $record = GedcomRecord::getInstance($id, $WT_TREE); 93 if ($record && $record->canShow()) { 94 $content .= '<tr>'; 95 if ($count_placement == 'before') { 96 $content .= '<td dir="ltr" style="text-align:right">[' . $count . ']</td>'; 97 } 98 $content .= '<td class="name2" ><a href="' . $record->getHtmlUrl() . '">' . $record->getFullName() . '</a></td>'; 99 if ($count_placement == 'after') { 100 $content .= '<td dir="ltr" style="text-align:right">[' . $count . ']</td>'; 101 } 102 $content .= '</tr>'; 103 } 104 } 105 $content .= "</table>"; 106 107 if ($template) { 108 return Theme::theme()->formatBlock($id, $title, $class, $content); 109 } else { 110 return $content; 111 } 112 } 113 114 /** 115 * Should this block load asynchronously using AJAX? 116 * 117 * Simple blocks are faster in-line, more comples ones 118 * can be loaded later. 119 * 120 * @return bool 121 */ 122 public function loadAjax() { 123 return true; 124 } 125 126 /** 127 * Can this block be shown on the user’s home page? 128 * 129 * @return bool 130 */ 131 public function isUserBlock() { 132 return false; 133 } 134 135 /** 136 * Can this block be shown on the tree’s home page? 137 * 138 * @return bool 139 */ 140 public function isGedcomBlock() { 141 return true; 142 } 143 144 /** 145 * An HTML form to edit block settings 146 * 147 * @param int $block_id 148 */ 149 public function configureBlock($block_id) { 150 if (Filter::postBool('save') && Filter::checkCsrf()) { 151 $this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10)); 152 $this->setBlockSetting($block_id, 'count_placement', Filter::post('count_placement', 'before|after', 'before')); 153 } 154 155 $num = $this->getBlockSetting($block_id, 'num', '10'); 156 $count_placement = $this->getBlockSetting($block_id, 'count_placement', 'before'); 157 158 echo '<tr><td class="descriptionbox wrap width33">'; 159 echo /* I18N: ... to show in a list */ I18N::translate('Number of pages'); 160 echo '</td><td class="optionbox">'; 161 echo '<input type="text" name="num" size="2" value="', $num, '">'; 162 echo '</td></tr>'; 163 164 echo "<tr><td class=\"descriptionbox wrap width33\">"; 165 echo /* I18N: Label for a configuration option */ I18N::translate('Show counts before or after name'); 166 echo "</td><td class=\"optionbox\">"; 167 echo FunctionsEdit::selectEditControl('count_placement', ['before' => I18N::translate('before'), 'after' => I18N::translate('after')], null, $count_placement, ''); 168 echo '</td></tr>'; 169 } 170} 171