analyzer.php
9.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?php
// namespace administrator\components\com_jmap\models;
/**
* @package JMAP::ANALYZER::administrator::components::com_jmap
* @subpackage models
* @author Joomla! Extensions Store
* @copyright (C) 2015 - Joomla! Extensions Store
* @license GNU/GPLv2 http://www.gnu.org/licenses/gpl-2.0.html
*/
defined ( '_JEXEC' ) or die ( 'Restricted access' );
jimport ( 'joomla.filesystem.file' );
/**
* Analyzer concrete model
* Operates not on DB but directly on a cached copy of the XML sitemap file
*
* @package JMAP::ANALYZER::administrator::components::com_jmap
* @subpackage models
* @since 2.3.3
*/
class JMapModelAnalyzer extends JMapModel {
/**
* Number of XML records
*
* @access private
* @var Int
*/
private $recordsNumber;
/**
* Counter result set
*
* @access public
* @return int
*/
public function getTotal() {
// Return simply the XML records number
return $this->recordsNumber;
}
/**
* Main get data method
*
* @access public
* @return Object[]
*/
public function getData() {
// Load data from XML file, parse it to load records
$cachedSitemapFilePath = JPATH_COMPONENT_ADMINISTRATOR . '/cache/analyzer/';
$originalBackendLanguageTag = $this->app->getLanguage()->getTag();
// Has sitemap some vars such as lang or Itemid?
$sitemapLang = $this->getState('sitemaplang', '');
$sitemapLinksLang = $sitemapLang ? $sitemapLang . '/' : '';
$sitemapLang = $sitemapLang ? '_' . $sitemapLang : '';
$sitemapDataset = $this->getState('sitemapdataset', '');
$sitemapDataset = $sitemapDataset ? '_dataset' . (int)$sitemapDataset : '';
$sitemapItemid = $this->getState('sitemapitemid', '');
$sitemapItemid = $sitemapItemid ? '_menuid' . (int)$sitemapItemid : '';
// Final name
$cachedSitemapFilename = 'sitemap_xml' . $sitemapLang . $sitemapDataset . $sitemapItemid . '.xml';
// Start processing
try {
// Now check if the file correctly exists
if(JFile::exists($cachedSitemapFilePath . $cachedSitemapFilename)) {
$loadedSitemapXML = simplexml_load_file($cachedSitemapFilePath . $cachedSitemapFilename);
if(!$loadedSitemapXML) {
throw new JMapException ( 'Invalid XML', 'error' );
}
} else {
throw new JMapException ( JText::sprintf ( 'COM_JMAP_ANALYZER_NOCACHED_FILE_EXISTS', $this->_db->getErrorMsg () ), 'error' );
}
// Execute HTTP request and associate HTTP response code with each record links
$httpClient = new JMapHttp();
if($loadedSitemapXML->url->count()) {
// Manage splice pagination here for the XML records
$convertedIteratorToArray = iterator_to_array($loadedSitemapXML->url, false);
// Store number of records for pagination
$this->recordsNumber = count($convertedIteratorToArray);
// Execute pagination splicing if any limit is set
$limit = $this->getState ( 'limit' );
if($limit) {
$loadedSitemapXML = array_splice($convertedIteratorToArray, $this->getState ( 'limitstart' ), $this->getState ( 'limit' ));
} else {
$loadedSitemapXML = $convertedIteratorToArray;
}
// Now start the Analyzer
$linksAnalyzerWorkingMode = $this->getComponentParams()->get('linksanalyzer_workingmode', 1);
if($linksAnalyzerWorkingMode) {
$siteRouter = JRouterSite::getInstance('site', array('mode'=>JROUTER_MODE_SEF));
}
// Check the Analyzer Analysis working mode for the validation of links
$validationAnalysisStandard = (bool)($this->getComponentParams()->get('linksanalyzer_validation_analysis', 2) == 2);
if( version_compare(JVERSION, '3.4', '>=')) {
JApplicationCms::getInstance('site')->loadLanguage();
}
$forceScheme = false;
if ( version_compare(JVERSION, '3.7', '>=') && $this->app->get('force_ssl') >= 1) {
$forceScheme = true;
}
// Add compatibility support for J3.9 new router between sites management
$removeLanguageSef = true;
if(version_compare(JVERSION, '3.9', '>=')) {
$removeLanguageSef = false;
}
$headers = array('Accept'=>'text/html', 'User-Agent'=>'JSitemapbot/1.0');
foreach ($loadedSitemapXML as $url) {
if($validationAnalysisStandard) {
$httpResponse = $httpClient->get($url->loc, $headers);
$url->httpstatus = $httpResponse->code;
}
// Find informations about the link, component and menu itemid if any, need a workaround to parse correctly from backend
if($linksAnalyzerWorkingMode) {
$baseAdmin = JUri::base();
$baseSite = str_replace('/administrator', '', $baseAdmin);
$fakedUrl = str_replace($baseSite, $baseAdmin, $url->loc);
if($removeLanguageSef) {
$fakedUrl = str_replace($sitemapLinksLang, '', $fakedUrl);
}
$fakedUrl = str_replace('/index.php', '', $fakedUrl);
// Now instantiate and parse the faked url from backend, replacing the uri base it will be = site
$uriObject = JUri::getInstance((string)$fakedUrl);
try {
// Avoid parse uri redirects when saving an article
if ($forceScheme) {
$uriObject->setScheme('https');
}
$parseUri = $siteRouter->parse($uriObject);
} catch(Exception $e) {
// Always ignore the new router exceptions in order to evaluate error codes
}
}
// Now augment the object to show informations
$url->component = isset($parseUri['option']) ? $parseUri['option'] : '-';
$url->menuId = isset($parseUri['Itemid']) ? $parseUri['Itemid'] : '-';
$url->menuTitle = '-';
// Translate human menu
if(isset($parseUri['Itemid'])) {
$query = "SELECT" . $this->_db->quoteName('title') .
"\n FROM #__menu" .
"\n WHERE " .
$this->_db->quoteName('id') . " = " . (int)$parseUri['Itemid'];
$menuTitle = $this->_db->setQuery($query)->loadResult();
$url->menuTitle = $menuTitle;
}
}
// Override always the $siteRouter->parse language from the frontend side link applying the original backend language
if(version_compare(JVERSION, '3.9', '>=') && $linksAnalyzerWorkingMode && $sitemapLinksLang) {
$jLang = JFactory::getLanguage();
$jLang->setLanguage($originalBackendLanguageTag);
$jLang->load('com_jmap', JPATH_COMPONENT_ADMINISTRATOR, 'en-GB', true, true);
if($originalBackendLanguageTag != 'en-GB') {
$jLang->load('com_jmap', JPATH_ADMINISTRATOR, $originalBackendLanguageTag, true, false);
$jLang->load('com_jmap', JPATH_COMPONENT_ADMINISTRATOR, $originalBackendLanguageTag, true, false);
}
}
// Perform array sorting if any
$order = $this->getState('order', null);
$jmapAnalyzerOrderDir = $this->getState('order_dir', 'asc');
if($validationAnalysisStandard && $order == 'httpstatus') {
function cmpAsc($a, $b){
return ((int)$a->httpstatus < (int)$b->httpstatus) ? -1 : 1;
}
function cmpDesc($a, $b){
return ((int)$a->httpstatus > (int)$b->httpstatus) ? -1 : 1;
}
$callbackName = ($jmapAnalyzerOrderDir == 'asc') ? 'cmpAsc' : 'cmpDesc';
usort($loadedSitemapXML, $callbackName);
}
if($order == 'link') {
function cmpAsc($a, $b){
return strcmp($a->loc, $b->loc);
}
function cmpDesc($a, $b){
return strcmp($b->loc, $a->loc);
}
$callbackName = ($jmapAnalyzerOrderDir == 'asc') ? 'cmpAsc' : 'cmpDesc';
usort($loadedSitemapXML, $callbackName);
}
} else {
throw new JMapException ( JText::sprintf ( 'COM_JMAP_ANALYZER_EMPTY_SITEMAP', $this->_db->getErrorMsg () ), 'notice' );
}
} catch ( JMapException $e ) {
$this->app->enqueueMessage ( $e->getMessage (), $e->getErrorLevel () );
$loadedSitemapXML = array ();
} catch ( Exception $e ) {
$jmapException = new JMapException ( $e->getMessage (), 'error' );
$this->app->enqueueMessage ( $jmapException->getMessage (), $jmapException->getErrorLevel () );
$loadedSitemapXML = array ();
}
return $loadedSitemapXML;
}
/**
* Return select lists used as filter for listEntities
*
* @access public
* @return array
*/
public function getFilters() {
$validationType = (int)($this->getComponentParams()->get('linksanalyzer_validation_analysis', 2));
$filteringFunction = ($validationType == 2) ? 'onchange="Joomla.submitform();"' : 'class="noanalyzer" onchange="JMapAnalyzer.filterOnAsyncPage(this);"';
$selectName = ($validationType == 2) ? 'filter_type' : 'async_type';
$datasourceTypes = array ();
$datasourceTypes [] = JHtml::_ ( 'select.option', null, JText::_ ( 'COM_JMAP_ANALYZER_ALL' ) );
$datasourceTypes [] = JHtml::_ ( 'select.option', '200', JText::_ ( 'COM_JMAP_ANALYZER_200' ) );
$datasourceTypes [] = JHtml::_ ( 'select.option', '301', JText::_ ( 'COM_JMAP_ANALYZER_301' ) );
$datasourceTypes [] = JHtml::_ ( 'select.option', '303', JText::_ ( 'COM_JMAP_ANALYZER_303' ) );
$datasourceTypes [] = JHtml::_ ( 'select.option', '404', JText::_ ( 'COM_JMAP_ANALYZER_404' ) );
$datasourceTypes [] = JHtml::_ ( 'select.option', '500', JText::_ ( 'COM_JMAP_ANALYZER_500' ) );
$filters ['type'] = JHtml::_ ( 'select.genericlist', $datasourceTypes, $selectName, $filteringFunction, 'value', 'text', $this->getState ( 'link_type' ) );
return $filters;
}
}