1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2017 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\Bootstrap4; 20use Fisharebest\Webtrees\Database; 21use Fisharebest\Webtrees\Filter; 22use Fisharebest\Webtrees\GedcomRecord; 23use Fisharebest\Webtrees\Html; 24use Fisharebest\Webtrees\I18N; 25use Fisharebest\Webtrees\View; 26 27/** 28 * Class TopPageViewsModule 29 */ 30class TopPageViewsModule extends AbstractModule implements ModuleBlockInterface { 31 /** 32 * How should this module be labelled on tabs, menus, etc.? 33 * 34 * @return string 35 */ 36 public function getTitle() { 37 return /* I18N: Name of a module */ I18N::translate('Most viewed pages'); 38 } 39 40 /** 41 * A sentence describing what this module does. 42 * 43 * @return string 44 */ 45 public function getDescription() { 46 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.'); 47 } 48 49 /** 50 * Generate the HTML content of this block. 51 * 52 * @param int $block_id 53 * @param bool $template 54 * @param string[] $cfg 55 * 56 * @return string 57 */ 58 public function getBlock($block_id, $template = true, $cfg = []) { 59 global $ctype, $WT_TREE; 60 61 $num = $this->getBlockSetting($block_id, 'num', '10'); 62 $count_placement = $this->getBlockSetting($block_id, 'count_placement', 'before'); 63 64 foreach (['count_placement', 'num'] as $name) { 65 if (array_key_exists($name, $cfg)) { 66 $$name = $cfg[$name]; 67 } 68 } 69 70 // load the lines from the file 71 $top10 = Database::prepare( 72 "SELECT page_parameter, page_count" . 73 " FROM `##hit_counter`" . 74 " WHERE gedcom_id = :tree_id AND page_name IN ('individual.php','family.php','source.php','repo.php','note.php','mediaviewer.php')" . 75 " ORDER BY page_count DESC LIMIT :limit" 76 )->execute([ 77 'tree_id' => $WT_TREE->getTreeId(), 78 'limit' => (int) $num, 79 ])->fetchAssoc(); 80 81 $content = '<table>'; 82 foreach ($top10 as $id => $count) { 83 $record = GedcomRecord::getInstance($id, $WT_TREE); 84 if ($record && $record->canShow()) { 85 $content .= '<tr>'; 86 if ($count_placement == 'before') { 87 $content .= '<td dir="ltr" style="text-align:right">[' . $count . ']</td>'; 88 } 89 $content .= '<td class="name2" ><a href="' . $record->getHtmlUrl() . '">' . $record->getFullName() . '</a></td>'; 90 if ($count_placement == 'after') { 91 $content .= '<td dir="ltr" style="text-align:right">[' . $count . ']</td>'; 92 } 93 $content .= '</tr>'; 94 } 95 } 96 $content .= '</table>'; 97 98 if ($template) { 99 if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) { 100 $config_url = Html::url('block_edit.php', ['block_id' => $block_id, 'ged' => $WT_TREE->getName()]); 101 } else { 102 $config_url = ''; 103 } 104 105 return View::make('blocks/template', [ 106 'block' => str_replace('_', '-', $this->getName()), 107 'id' => $block_id, 108 'config_url' => $config_url, 109 'title' => $this->getTitle(), 110 'content' => $content, 111 ]); 112 } else { 113 return $content; 114 } 115 } 116 117 /** 118 * Should this block load asynchronously using AJAX? 119 * 120 * Simple blocks are faster in-line, more comples ones 121 * can be loaded later. 122 * 123 * @return bool 124 */ 125 public function loadAjax() { 126 return true; 127 } 128 129 /** 130 * Can this block be shown on the user’s home page? 131 * 132 * @return bool 133 */ 134 public function isUserBlock() { 135 return false; 136 } 137 138 /** 139 * Can this block be shown on the tree’s home page? 140 * 141 * @return bool 142 */ 143 public function isGedcomBlock() { 144 return true; 145 } 146 147 /** 148 * An HTML form to edit block settings 149 * 150 * @param int $block_id 151 */ 152 public function configureBlock($block_id) { 153 if (Filter::postBool('save') && Filter::checkCsrf()) { 154 $this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10)); 155 $this->setBlockSetting($block_id, 'count_placement', Filter::post('count_placement', 'before|after', 'before')); 156 } 157 158 $num = $this->getBlockSetting($block_id, 'num', '10'); 159 $count_placement = $this->getBlockSetting($block_id, 'count_placement', 'before'); 160 161 echo '<div class="form-group row"><label class="col-sm-3 col-form-label" for="num">'; 162 echo /* I18N: ... to show in a list */ I18N::translate('Number of pages'); 163 echo '</label><div class="col-sm-9">'; 164 echo '<input type="text" name="num" size="2" value="', $num, '">'; 165 echo '</div></div>'; 166 167 echo '<div class="form-group row"><label class="col-sm-3 col-form-label" for="count_placement">'; 168 echo /* I18N: Label for a configuration option */ I18N::translate('Show counts before or after name'); 169 echo '</label><div class="col-sm-9">'; 170 echo Bootstrap4::select(['before' => I18N::translate('before'), 'after' => I18N::translate('after')], $count_placement, ['id' => 'count_placement', 'name' => 'count_placement']); 171 echo '</div></div>'; 172 } 173} 174