Mapper::generate() - Code Metrics - Inspection of "some small fixes for PSR2" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2 ( 9ddafc...b78f68 )

by Andreas

created 2018-06-15 09:52 UTC

Mapper::generate() C

↳ Parent: Mapper

Complexity

Conditions	13
Paths	25

Size

Total Lines	44
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	28
nc	25
nop	0
dl	0
loc	44
rs	5.1234
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * Sitemap handling functions
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Michael Hamann <[email protected]>
 */

namespace dokuwiki\Sitemap;

/**
 * A class for building sitemaps and pinging search engines with the sitemap URL.
 *
 * @author Michael Hamann
 */
class Mapper {
    /**
     * Builds a Google Sitemap of all public pages known to the indexer
     *
     * The map is placed in the cache directory named sitemap.xml.gz - This
     * file needs to be writable!
     *
     * @author Michael Hamann
     * @author Andreas Gohr
     * @link   https://www.google.com/webmasters/sitemaps/docs/en/about.html
     * @link   http://www.sitemaps.org/
     *
     * @return bool
     */
    public static function generate(){
        global $conf;
        if($conf['sitemap'] < 1 || !is_numeric($conf['sitemap'])) return false;

        $sitemap = Mapper::getFilePath();

        if(file_exists($sitemap)){
            if(!is_writable($sitemap)) return false;
        }else{
            if(!is_writable(dirname($sitemap))) return false;
        }

        if(@filesize($sitemap) &&
           @filemtime($sitemap) > (time()-($conf['sitemap']*86400))){ // 60*60*24=86400
            dbglog('Sitemapper::generate(): Sitemap up to date');
            return false;
        }

        dbglog("Sitemapper::generate(): using $sitemap");

        $pages = idx_get_indexer()->getPages();
        dbglog('Sitemapper::generate(): creating sitemap using '.count($pages).' pages');
        $items = array();

        // build the sitemap items
        foreach($pages as $id){
            //skip hidden, non existing and restricted files
            if(isHiddenPage($id)) continue;
            if(auth_aclcheck($id,'',array()) < AUTH_READ) continue;
            $item = Item::createFromID($id);
            if ($item !== null)
                $items[] = $item;
        }

        $eventData = array('items' => &$items, 'sitemap' => &$sitemap);
        $event = new \Doku_Event('SITEMAP_GENERATE', $eventData);
        if ($event->advise_before(true)) {
            //save the new sitemap
            $event->result = io_saveFile($sitemap, Mapper::getXML($items));
        }
        $event->advise_after();

        return $event->result;
    }

    /**
     * Builds the sitemap XML string from the given array auf SitemapItems.
     *
     * @param $items array The SitemapItems that shall be included in the sitemap.
     * @return string The sitemap XML.
     *
     * @author Michael Hamann
     */
    private static function getXML($items) {
        ob_start();
        echo '<?xml version="1.0" encoding="UTF-8"?>'.NL;
        echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'.NL;
        foreach ($items as $item) {
            /** @var Item $item */
            echo $item->toXML();
        }
        echo '</urlset>'.NL;
        $result = ob_get_contents();
        ob_end_clean();
        return $result;
    }

    /**
     * Helper function for getting the path to the sitemap file.
     *
     * @return string The path to the sitemap file.
     *
     * @author Michael Hamann
     */
    public static function getFilePath() {
        global $conf;

        $sitemap = $conf['cachedir'].'/sitemap.xml';
        if (self::sitemapIsCompressed()) {
            $sitemap .= '.gz';
        }

        return $sitemap;
    }

    /**
     * Helper function for checking if the sitemap is compressed
     *
     * @return bool If the sitemap file is compressed
     */
    public static function sitemapIsCompressed() {
        global $conf;
        return $conf['compression'] === 'bz2' || $conf['compression'] === 'gz';
    }

    /**
     * Pings search engines with the sitemap url. Plugins can add or remove
     * urls to ping using the SITEMAP_PING event.
     *
     * @author Michael Hamann
     *
     * @return bool
     */
    public static function pingSearchEngines() {
        //ping search engines...
        $http = new \DokuHTTPClient();
        $http->timeout = 8;

        $encoded_sitemap_url = urlencode(wl('', array('do' => 'sitemap'), true, '&'));
        $ping_urls = array(
            'google'    => 'http://www.google.com/webmasters/sitemaps/ping?sitemap='.$encoded_sitemap_url,
            'microsoft' => 'http://www.bing.com/webmaster/ping.aspx?siteMap='.$encoded_sitemap_url,
            'yandex'    => 'http://blogs.yandex.ru/pings/?status=success&url='.$encoded_sitemap_url
        );

        $data = array('ping_urls' => $ping_urls,
                            'encoded_sitemap_url' => $encoded_sitemap_url
        );
        $event = new \Doku_Event('SITEMAP_PING', $data);
        if ($event->advise_before(true)) {
            foreach ($data['ping_urls'] as $name => $url) {
                dbglog("Sitemapper::PingSearchEngines(): pinging $name");
                $resp = $http->get($url);
                if($http->error) dbglog("Sitemapper:pingSearchengines(): $http->error");
                dbglog('Sitemapper:pingSearchengines(): '.preg_replace('/[\n\r]/',' ',strip_tags($resp)));
            }
        }
        $event->advise_after();

        return true;
    }
}



1			<?php
2			/**
3			* Sitemap handling functions
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Michael Hamann <[email protected]>
7			*/
8
9			namespace dokuwiki\Sitemap;
10
11			/**
12			* A class for building sitemaps and pinging search engines with the sitemap URL.
13			*
14			* @author Michael Hamann
15			*/
16			class Mapper {
17			/**
18			* Builds a Google Sitemap of all public pages known to the indexer
19			*
20			* The map is placed in the cache directory named sitemap.xml.gz - This
21			* file needs to be writable!
22			*
23			* @author Michael Hamann
24			* @author Andreas Gohr
25			* @link https://www.google.com/webmasters/sitemaps/docs/en/about.html
26			* @link http://www.sitemaps.org/
27			*
28			* @return bool
29			*/
30			public static function generate(){
31			global $conf;
32			if($conf['sitemap'] < 1 \|\| !is_numeric($conf['sitemap'])) return false;
33
34			$sitemap = Mapper::getFilePath();
35
36			if(file_exists($sitemap)){
37			if(!is_writable($sitemap)) return false;
38			}else{
39			if(!is_writable(dirname($sitemap))) return false;
40			}
41
42			if(@filesize($sitemap) &&
43			@filemtime($sitemap) > (time()-($conf['sitemap']86400))){ // 6060*24=86400
44			dbglog('Sitemapper::generate(): Sitemap up to date');
45			return false;
46			}
47
48			dbglog("Sitemapper::generate(): using $sitemap");
49
50			$pages = idx_get_indexer()->getPages();
51			dbglog('Sitemapper::generate(): creating sitemap using '.count($pages).' pages');
52			$items = array();
53
54			// build the sitemap items
55			foreach($pages as $id){
56			//skip hidden, non existing and restricted files
57			if(isHiddenPage($id)) continue;
58			if(auth_aclcheck($id,'',array()) < AUTH_READ) continue;
59			$item = Item::createFromID($id);
60			if ($item !== null)
61			$items[] = $item;
62			}
63
64			$eventData = array('items' => &$items, 'sitemap' => &$sitemap);
65			$event = new \Doku_Event('SITEMAP_GENERATE', $eventData);
66			if ($event->advise_before(true)) {
67			//save the new sitemap
68			$event->result = io_saveFile($sitemap, Mapper::getXML($items));
69			}
70			$event->advise_after();
71
72			return $event->result;
73			}
74
75			/**
76			* Builds the sitemap XML string from the given array auf SitemapItems.
77			*
78			* @param $items array The SitemapItems that shall be included in the sitemap.
79			* @return string The sitemap XML.
80			*
81			* @author Michael Hamann
82			*/
83			private static function getXML($items) {
84			ob_start();
85			echo '<?xml version="1.0" encoding="UTF-8"?>'.NL;
86			echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'.NL;
87			foreach ($items as $item) {
88			/** @var Item $item */
89			echo $item->toXML();
90			}
91			echo '</urlset>'.NL;
92			$result = ob_get_contents();
93			ob_end_clean();
94			return $result;
95			}
96
97			/**
98			* Helper function for getting the path to the sitemap file.
99			*
100			* @return string The path to the sitemap file.
101			*
102			* @author Michael Hamann
103			*/
104			public static function getFilePath() {
105			global $conf;
106
107			$sitemap = $conf['cachedir'].'/sitemap.xml';
108			if (self::sitemapIsCompressed()) {
109			$sitemap .= '.gz';
110			}
111
112			return $sitemap;
113			}
114
115			/**
116			* Helper function for checking if the sitemap is compressed
117			*
118			* @return bool If the sitemap file is compressed
119			*/
120			public static function sitemapIsCompressed() {
121			global $conf;
122			return $conf['compression'] === 'bz2' \|\| $conf['compression'] === 'gz';
123			}
124
125			/**
126			* Pings search engines with the sitemap url. Plugins can add or remove
127			* urls to ping using the SITEMAP_PING event.
128			*
129			* @author Michael Hamann
130			*
131			* @return bool
132			*/
133			public static function pingSearchEngines() {
134			//ping search engines...
135			$http = new \DokuHTTPClient();
136			$http->timeout = 8;
137
138			$encoded_sitemap_url = urlencode(wl('', array('do' => 'sitemap'), true, '&'));
139			$ping_urls = array(
140			'google' => 'http://www.google.com/webmasters/sitemaps/ping?sitemap='.$encoded_sitemap_url,
141			'microsoft' => 'http://www.bing.com/webmaster/ping.aspx?siteMap='.$encoded_sitemap_url,
142			'yandex' => 'http://blogs.yandex.ru/pings/?status=success&url='.$encoded_sitemap_url
143			);
144
145			$data = array('ping_urls' => $ping_urls,
146			'encoded_sitemap_url' => $encoded_sitemap_url
147			);
148			$event = new \Doku_Event('SITEMAP_PING', $data);
149			if ($event->advise_before(true)) {
150			foreach ($data['ping_urls'] as $name => $url) {
151			dbglog("Sitemapper::PingSearchEngines(): pinging $name");
152			$resp = $http->get($url);
153			if($http->error) dbglog("Sitemapper:pingSearchengines(): $http->error");
154			dbglog('Sitemapper:pingSearchengines(): '.preg_replace('/[\n\r]/',' ',strip_tags($resp)));
155			}
156			}
157			$event->advise_after();
158
159			return true;
160			}
161			}
162
163

splitbrain / dokuwiki

Push — psr2 ( 9ddafc...b78f68 )

Mapper::generate() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like