Changeset 112586 in spip-zone

Timestamp:

Dec 1, 2018, 3:50:26 PM (2 years ago)

Author:

james@…

Message:

Commentaires, Docblocks, code mort again

Location:

_dev_/univers_spip

Files:

• base/univers.php (modified) (1 diff)
• genie/univers_feed.php (modified) (1 diff)
• inc/univers.php (modified) (14 diffs)

_dev_/univers_spip/base/univers.php

@@ -1 +1 @@
 <?php
-/*
+
+/**
  * Plugin Univers SPIP
  * (c) 2010 Cedric
  * Distribue sous licence GPL
- *
  */
-
 
 if (!defined('_ECRIRE_INC_VERSION')) {

_dev_/univers_spip/genie/univers_feed.php

@@ -7 +7 @@
  */
 
+/**
+ * Tache periodique d'examen des flux RSS pour decouvrir et proposer des nouveaux sites SPIP.
+ *
+ * @param      mixed   $t      Unused parameter
+ *
+ * @return     integer  0
+ */
 function genie_univers_feed_dist($t) {
         include_spip('inc/univers');

_dev_/univers_spip/inc/univers.php

@@ -11 +11 @@
 include_spip('inc/meta');
 
-function univers_proposer_site($url, $desc = '') {
+/**
+ * Proposer un site en l'enregistrant en base.
+ *
+ * @param      string   $url    URL du site propose
+ *
+ * @return     integer  0 (false) ou l'id en base du site propose
+ */
+function univers_proposer_site($url) {
         $parts = parse_url($url);
         // pas d'IP fixe !
         if (preg_match(';^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$;', $parts['host'])) {
-                return false;
+                return 0;
         }
         // pas de fausse url venant de feedburner ou google !
@@ -21 +28 @@
         // attraper le vrai nom du site
         if (preg_match(',(feeds\.feedburner\.com|feedproxy\.google\.com),i', $parts['host'])) {
-                return false;
+                return 0;
         }
         
-        #if (is_utf8($parts['host']))
-        #       return false;
-
-        #$parts['path'] = preg_replace(",(IMG|local)/cache.+spip[.]php,","spip.php",$parts['path']);
         $base = $parts['scheme'] . '://' . $parts['host'] . $parts['path'];
         $base = univers_nettoyer_url($base);
@@ -41 +44 @@
         }
 
-        $id_website = sql_insertq('spip_websites', array('url'=>$base,'descriptif'=>$desc,'date'=>date('Y-m-d H:i:s')));
+        $id_website = sql_insertq('spip_websites', array('url'=>$base, 'descriptif'=> '', 'date'=>date('Y-m-d H:i:s')));
 
         // relire et verifier
@@ -48 +51 @@
                 // il y a eu un caractere exotique dans l'url, on la vire
                 sql_delete('spip_websites', 'id_website='.intval($id_website));
-                return false;
+                return 0;
         }
 
@@ -54 +57 @@
 }
 
-// reparer les urls mal formees
+/**
+ * Reparer les urls mal formees.
+ *
+ * @param      string  $url    URL a nettoyer
+ *
+ * @return     string  URL nettoyee
+ */
 function univers_nettoyer_url($url) {
         $url = preg_replace(',(IMG|local)/cache.+spip[.]php,', 'spip.php', $url);
@@ -64 +73 @@
 }
 
+/**
+ * Nettoyage en base des URLs enregistrees malformees.
+ */
 function univers_nettoyer_urls() {
         // urls mal formees
@@ -147 +159 @@
 }
 
-function univers_twitter_extraire_feed_urls($url, $enlarge = true) {
+/**
+ * Recuperer les URLs des sites a verifier.
+ *
+ * @param      sintrg   $url      Adresse du flux RSS
+ *
+ * @return     array    Liste des sites a verifier
+ */
+function univers_twitter_extraire_feed_urls($url) {
         $long = array();
         $urls = array();
@@ -164 +183 @@
                         if (!isset($long[$url])) {
                                 $long[$url] = recuperer_lapage($url, false, 'GET', 100000);
-                                $long[$url] = (is_string($long[$url])?$long[$url]:false);
+                                $long[$url] = (is_string($long[$url]) ? $long[$url] : false);
                         }
                         if ($long[$url]) {
@@ -179 +198 @@
 }
 
+/**
+ * Recuperer les URLs des sites a verifier.
+ *
+ * @param      strng  $url    Adresse du flux RSS
+ *
+ * @return     array   Liste des sites a verifier
+ */
 function univers_spipnet_extraire_feed_urls($url) {
         $urls = array();
@@ -193 +219 @@
 }
 
-function univers_feed_watch($echo = false) {
+/**
+ * Vérifie un coup sur 2 les flux RSS du blog et du site officiel.
+ */
+function univers_feed_watch() {
         $explore = array(
                 'twitter' => 'https://blog.spip.net/?page=backend-twitter-spip',
@@ -199 +228 @@
         );
 
+        // Alternance des flux a verifier
         $feed = 0;
         if (isset($GLOBALS['meta']['univers_feedwatch'])) {
@@ -204 +234 @@
         }
 
-
         $i = 0;
         while ($i++<$feed) {
@@ -210 +239 @@
         }
 
+        //Verification d'un flux
         list($type, $url) = each($explore);
         if (function_exists($f = "univers_$type".'_extraire_feed_urls')) {
                 spip_log($s = "Analyse Feed $url", 'univers');
-                if ($echo) {
-                        echo "$s<br />";
-                }
                 $liste = $f($url);
 
                 foreach ($liste as $url) {
                         spip_log($s = "$url", 'univers');
-                        if ($echo) {
-                                echo "$s<br />";
-                        }
                         univers_proposer_site($url);
                 }
         }
 
+        // Alternance des flux a verifier
         $feed++;
         if ($feed>=count($explore)) {
@@ -232 +257 @@
         }
         ecrire_meta('univers_feedwatch', $feed);
+
         // un coup de netoyage sur les urls mal formees
         univers_nettoyer_urls();