Mark as FIXME. This three calls leak a png filename in sys_get_temp_dir() each,
[lhc/web/wiklou.git] / includes / LinksUpdate.php
index ec7960f..0002096 100644 (file)
@@ -241,6 +241,7 @@ class LinksUpdate {
                foreach ( $batches as $batch ) {
                        list( $start, $end ) = $batch;
                        $params = array(
+                               'table' => 'templatelinks',
                                'start' => $start,
                                'end' => $end,
                        );
@@ -296,27 +297,38 @@ class LinksUpdate {
                );
        }
 
+       /**
+        * @param $cats
+        */
        function invalidateCategories( $cats ) {
                $this->invalidatePages( NS_CATEGORY, array_keys( $cats ) );
        }
 
        /**
         * Update all the appropriate counts in the category table.
-        * @param $added associative array of category name => sort key
-        * @param $deleted associative array of category name => sort key
+        * @param $added array associative array of category name => sort key
+        * @param $deleted array associative array of category name => sort key
         */
        function updateCategoryCounts( $added, $deleted ) {
-               $a = new Article($this->mTitle);
+               $a = WikiPage::factory( $this->mTitle );
                $a->updateCategoryCounts(
                        array_keys( $added ), array_keys( $deleted )
                );
        }
 
+       /**
+        * @param $images
+        */
        function invalidateImageDescriptions( $images ) {
                $this->invalidatePages( NS_FILE, array_keys( $images ) );
        }
 
-       function dumbTableUpdate( $table, $insertions, $fromField ) {
+       /**
+        * @param $table
+        * @param $insertions
+        * @param $fromField
+        */
+       private function dumbTableUpdate( $table, $insertions, $fromField ) {
                $this->mDb->delete( $table, array( $fromField => $this->mId ), __METHOD__ );
                if ( count( $insertions ) ) {
                        # The link array was constructed without FOR UPDATE, so there may
@@ -328,7 +340,10 @@ class LinksUpdate {
 
        /**
         * Update a table by doing a delete query then an insert query
-        * @private
+        * @param $table
+        * @param $prefix
+        * @param $deletions
+        * @param $insertions
         */
        function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
                if ( $table == 'page_props' ) {
@@ -371,13 +386,13 @@ class LinksUpdate {
                }
        }
 
-
        /**
         * Get an array of pagelinks insertions for passing to the DB
         * Skips the titles specified by the 2-D array $existing
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getLinkInsertions( $existing = array() ) {
+       private function getLinkInsertions( $existing = array() ) {
                $arr = array();
                foreach( $this->mLinks as $ns => $dbkeys ) {
                        $diffs = isset( $existing[$ns] )
@@ -396,9 +411,10 @@ class LinksUpdate {
 
        /**
         * Get an array of template insertions. Like getLinkInsertions()
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getTemplateInsertions( $existing = array() ) {
+       private function getTemplateInsertions( $existing = array() ) {
                $arr = array();
                foreach( $this->mTemplates as $ns => $dbkeys ) {
                        $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
@@ -416,9 +432,10 @@ class LinksUpdate {
        /**
         * Get an array of image insertions
         * Skips the names specified in $existing
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getImageInsertions( $existing = array() ) {
+       private function getImageInsertions( $existing = array() ) {
                $arr = array();
                $diffs = array_diff_key( $this->mImages, $existing );
                foreach( $diffs as $iname => $dummy ) {
@@ -432,9 +449,10 @@ class LinksUpdate {
 
        /**
         * Get an array of externallinks insertions. Skips the names specified in $existing
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getExternalInsertions( $existing = array() ) {
+       private function getExternalInsertions( $existing = array() ) {
                $arr = array();
                $diffs = array_diff_key( $this->mExternals, $existing );
                foreach( $diffs as $url => $dummy ) {
@@ -450,11 +468,12 @@ class LinksUpdate {
        /**
         * Get an array of category insertions
         *
-        * @param $existing Array mapping existing category names to sort keys. If both
+        * @param $existing array mapping existing category names to sort keys. If both
         * match a link in $this, the link will be omitted from the output
-        * @private
+        *
+        * @return array
         */
-       function getCategoryInsertions( $existing = array() ) {
+       private function getCategoryInsertions( $existing = array() ) {
                global $wgContLang, $wgCategoryCollation;
                $diffs = array_diff_assoc( $this->mCategories, $existing );
                $arr = array();
@@ -494,9 +513,10 @@ class LinksUpdate {
         * Get an array of interlanguage link insertions
         *
         * @param $existing Array mapping existing language codes to titles
-        * @private
+        *
+        * @return array
         */
-       function getInterlangInsertions( $existing = array() ) {
+       private function getInterlangInsertions( $existing = array() ) {
                $diffs = array_diff_assoc( $this->mInterlangs, $existing );
                $arr = array();
                foreach( $diffs as $lang => $title ) {
@@ -511,6 +531,8 @@ class LinksUpdate {
 
        /**
         * Get an array of page property insertions
+        * @param $existing array
+        * @return array
         */
        function getPropertyInsertions( $existing = array() ) {
                $diffs = array_diff_assoc( $this->mProperties, $existing );
@@ -528,9 +550,10 @@ class LinksUpdate {
        /**
         * Get an array of interwiki insertions for passing to the DB
         * Skips the titles specified by the 2-D array $existing
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getInterwikiInsertions( $existing = array() ) {
+       private function getInterwikiInsertions( $existing = array() ) {
                $arr = array();
                foreach( $this->mInterwikis as $prefix => $dbkeys ) {
                        $diffs = isset( $existing[$prefix] ) ? array_diff_key( $dbkeys, $existing[$prefix] ) : $dbkeys;
@@ -548,9 +571,10 @@ class LinksUpdate {
        /**
         * Given an array of existing links, returns those links which are not in $this
         * and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getLinkDeletions( $existing ) {
+       private function getLinkDeletions( $existing ) {
                $del = array();
                foreach ( $existing as $ns => $dbkeys ) {
                        if ( isset( $this->mLinks[$ns] ) ) {
@@ -565,9 +589,10 @@ class LinksUpdate {
        /**
         * Given an array of existing templates, returns those templates which are not in $this
         * and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getTemplateDeletions( $existing ) {
+       private function getTemplateDeletions( $existing ) {
                $del = array();
                foreach ( $existing as $ns => $dbkeys ) {
                        if ( isset( $this->mTemplates[$ns] ) ) {
@@ -582,42 +607,47 @@ class LinksUpdate {
        /**
         * Given an array of existing images, returns those images which are not in $this
         * and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getImageDeletions( $existing ) {
+       private function getImageDeletions( $existing ) {
                return array_diff_key( $existing, $this->mImages );
        }
 
        /**
         * Given an array of existing external links, returns those links which are not
         * in $this and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getExternalDeletions( $existing ) {
+       private function getExternalDeletions( $existing ) {
                return array_diff_key( $existing, $this->mExternals );
        }
 
        /**
         * Given an array of existing categories, returns those categories which are not in $this
         * and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getCategoryDeletions( $existing ) {
+       private function getCategoryDeletions( $existing ) {
                return array_diff_assoc( $existing, $this->mCategories );
        }
 
        /**
         * Given an array of existing interlanguage links, returns those links which are not
         * in $this and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getInterlangDeletions( $existing ) {
+       private function getInterlangDeletions( $existing ) {
                return array_diff_assoc( $existing, $this->mInterlangs );
        }
 
        /**
         * Get array of properties which should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
        function getPropertyDeletions( $existing ) {
                return array_diff_assoc( $existing, $this->mProperties );
@@ -626,9 +656,10 @@ class LinksUpdate {
        /**
         * Given an array of existing interwiki links, returns those links which are not in $this
         * and thus should be deleted.
-        * @private
+        * @param $existing array
+        * @return array
         */
-       function getInterwikiDeletions( $existing ) {
+       private function getInterwikiDeletions( $existing ) {
                $del = array();
                foreach ( $existing as $prefix => $dbkeys ) {
                        if ( isset( $this->mInterwikis[$prefix] ) ) {
@@ -642,9 +673,10 @@ class LinksUpdate {
 
        /**
         * Get an array of existing links, as a 2-D array
-        * @private
+        *
+        * @return array
         */
-       function getExistingLinks() {
+       private function getExistingLinks() {
                $res = $this->mDb->select( 'pagelinks', array( 'pl_namespace', 'pl_title' ),
                        array( 'pl_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -659,9 +691,10 @@ class LinksUpdate {
 
        /**
         * Get an array of existing templates, as a 2-D array
-        * @private
+        *
+        * @return array
         */
-       function getExistingTemplates() {
+       private function getExistingTemplates() {
                $res = $this->mDb->select( 'templatelinks', array( 'tl_namespace', 'tl_title' ),
                        array( 'tl_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -676,9 +709,10 @@ class LinksUpdate {
 
        /**
         * Get an array of existing images, image names in the keys
-        * @private
+        *
+        * @return array
         */
-       function getExistingImages() {
+       private function getExistingImages() {
                $res = $this->mDb->select( 'imagelinks', array( 'il_to' ),
                        array( 'il_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -690,9 +724,10 @@ class LinksUpdate {
 
        /**
         * Get an array of existing external links, URLs in the keys
-        * @private
+        *
+        * @return array
         */
-       function getExistingExternals() {
+       private function getExistingExternals() {
                $res = $this->mDb->select( 'externallinks', array( 'el_to' ),
                        array( 'el_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -704,9 +739,10 @@ class LinksUpdate {
 
        /**
         * Get an array of existing categories, with the name in the key and sort key in the value.
-        * @private
+        *
+        * @return array
         */
-       function getExistingCategories() {
+       private function getExistingCategories() {
                $res = $this->mDb->select( 'categorylinks', array( 'cl_to', 'cl_sortkey_prefix' ),
                        array( 'cl_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -719,9 +755,10 @@ class LinksUpdate {
        /**
         * Get an array of existing interlanguage links, with the language code in the key and the
         * title in the value.
-        * @private
+        *
+        * @return array
         */
-       function getExistingInterlangs() {
+       private function getExistingInterlangs() {
                $res = $this->mDb->select( 'langlinks', array( 'll_lang', 'll_title' ),
                        array( 'll_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -750,9 +787,10 @@ class LinksUpdate {
 
        /**
         * Get an array of existing categories, with the name in the key and sort key in the value.
-        * @private
+        *
+        * @return array
         */
-       function getExistingProperties() {
+       private function getExistingProperties() {
                $res = $this->mDb->select( 'page_props', array( 'pp_propname', 'pp_value' ),
                        array( 'pp_page' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
@@ -762,16 +800,17 @@ class LinksUpdate {
                return $arr;
        }
 
-
        /**
         * Return the title object of the page being updated
+        * @return Title
         */
-       function getTitle() {
+       public function getTitle() {
                return $this->mTitle;
        }
 
        /**
         * Return the list of images used as generated by the parser
+        * @return array
         */
        public function getImages() {
                return $this->mImages;
@@ -779,8 +818,9 @@ class LinksUpdate {
 
        /**
         * Invalidate any necessary link lists related to page property changes
+        * @param $changed
         */
-       function invalidateProperties( $changed ) {
+       private function invalidateProperties( $changed ) {
                global $wgPagePropLinkInvalidations;
 
                foreach ( $changed as $name => $value ) {