MediaWiki  master
GenerateSitemap Class Reference

Maintenance script that generates a sitemap for the site. More...

Inheritance diagram for GenerateSitemap:
Collaboration diagram for GenerateSitemap:

Public Member Functions

 __construct ()
 
 close (&$handle)
 gzclose() / fclose() wrapper More...
 
 closeFile ()
 Return the XML required to close sitemap file. More...
 
 closeIndex ()
 Return the XML required to close a sitemap index file. More...
 
 execute ()
 Execute. More...
 
 fileEntry ( $url, $date, $priority)
 Return the XML for a single sitemap entry. More...
 
 generateLimit ( $namespace)
 Populate $this->limit. More...
 
 generateNamespaces ()
 Generate a one-dimensional array of existing namespaces. More...
 
 getPageRes ( $namespace)
 Return a database resolution of all the pages in a given namespace. More...
 
 guessPriority ( $namespace)
 If the namespace isn't listed on the priority list return the default priority for the namespace, varies depending on whether it's a talkpage or not. More...
 
 indexEntry ( $filename)
 Return the XML for a single sitemap indexfile entry. More...
 
 main ()
 Main loop. More...
 
 open ( $file, $flags)
 gzopen() / fopen() wrapper More...
 
 openFile ()
 Return the XML required to open a sitemap file. More...
 
 openIndex ()
 Return the XML required to open a sitemap index file. More...
 
 priority ( $namespace)
 Get the priority of a given namespace. More...
 
 sitemapFilename ( $namespace, $count)
 Get a sitemap filename. More...
 
 write (&$handle, $str)
 gzwrite() / fwrite() wrapper More...
 
 xmlHead ()
 Return the XML required to open an XML file. More...
 
 xmlSchema ()
 Return the XML schema being used. More...
 
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor. More...
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 execute ()
 Do the actual work. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 
 getName ()
 Get the script's name. More...
 
 globals ()
 Potentially debug globals. More...
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More...
 
 loadSettings ()
 Generic setup for most installs. More...
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments. More...
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates. More...
 
 setConfig (Config $config)
 
 setDB (IDatabase $db)
 Sets database object to be returned by getDB(). More...
 
 setup ()
 Do some sanity checking and basic setup. More...
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...
 

Public Attributes

bool $compress
 Whether or not to use compression. More...
 
object $dbr
 A database replica DB object. More...
 
resource $file
 A resource pointing to a sitemap file. More...
 
resource $findex
 A resource pointing to the sitemap index file. More...
 
string $fspath
 The path to prepend to the filename. More...
 
array $limit = []
 The number of entries to save in each sitemap file. More...
 
array $namespaces = []
 A one-dimensional array of namespaces in the wiki. More...
 
array $priorities = []
 Key => value entries of namespaces and their priorities. More...
 
int $size_limit
 The maximum size of a sitemap file. More...
 
bool $skipRedirects
 Whether or not to include redirection pages. More...
 
string $timestamp
 When this sitemap batch was generated. More...
 
int $url_limit
 The maximum amount of urls in a sitemap file. More...
 
string $urlpath
 The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath. More...
 
const GS_MAIN = -2
 
const GS_TALK = -1
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
const DB_STD = 1
 
const STDIN_ALL = 'all'
 

Private Member Functions

 setNamespacePriorities ()
 

Private Attributes

string $identifier
 Identifier to use in filenames, default $wgDBname. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static getTermSize ()
 Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows). More...
 
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...
 
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
 
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
 
static setLBFactoryTriggers (LBFactory $LBFactory, Config $config)
 
static shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More...
 
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 
 addDescription ( $text)
 Set the description text. More...
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script. More...
 
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. More...
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getBatchSize ()
 Returns batch size. More...
 
 getDB ( $db, $groups=[], $wiki=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 
 getStdin ( $len=null)
 Return input from stdin. More...
 
 hasArg ( $argId=0)
 Does a given argument exist? More...
 
 hasOption ( $name)
 Checks to see if a particular option exists. More...
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
 $mParams = []
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Detailed Description

Maintenance script that generates a sitemap for the site.

Definition at line 38 of file generateSitemap.php.

Constructor & Destructor Documentation

◆ __construct()

GenerateSitemap::__construct ( )

Definition at line 145 of file generateSitemap.php.

References Maintenance\addDescription(), and Maintenance\addOption().

Member Function Documentation

◆ close()

GenerateSitemap::close ( $handle)

gzclose() / fclose() wrapper

Parameters
resource&$handle

Definition at line 432 of file generateSitemap.php.

Referenced by main().

◆ closeFile()

GenerateSitemap::closeFile ( )

Return the XML required to close sitemap file.

Returns
string

Definition at line 535 of file generateSitemap.php.

Referenced by generateLimit(), and main().

◆ closeIndex()

GenerateSitemap::closeIndex ( )

Return the XML required to close a sitemap index file.

Returns
string

Definition at line 500 of file generateSitemap.php.

Referenced by main().

◆ execute()

◆ fileEntry()

GenerateSitemap::fileEntry (   $url,
  $date,
  $priority 
)

Return the XML for a single sitemap entry.

Parameters
string$urlAn RFC 2396 compliant URL
string$dateA ISO 8601 date
string$priorityA priority indicator, 0.0 - 1.0 inclusive with a 0.1 stepsize
Returns
string

Definition at line 521 of file generateSitemap.php.

Referenced by generateLimit(), and main().

◆ generateLimit()

GenerateSitemap::generateLimit (   $namespace)

Populate $this->limit.

Parameters
int$namespace

Definition at line 544 of file generateSitemap.php.

References $title, closeFile(), fileEntry(), Title\makeTitle(), openFile(), priority(), and wfTimestamp().

Referenced by main().

◆ generateNamespaces()

GenerateSitemap::generateNamespaces ( )

Generate a one-dimensional array of existing namespaces.

Definition at line 250 of file generateSitemap.php.

References $res, $wgSitemapNamespaces, as, and namespaces.

Referenced by execute().

◆ getPageRes()

GenerateSitemap::getPageRes (   $namespace)

Return a database resolution of all the pages in a given namespace.

Parameters
int$namespaceLimit the query to this namespace
Returns
Resource

Definition at line 304 of file generateSitemap.php.

Referenced by main().

◆ guessPriority()

GenerateSitemap::guessPriority (   $namespace)

If the namespace isn't listed on the priority list return the default priority for the namespace, varies depending on whether it's a talkpage or not.

Parameters
int$namespaceThe namespace to get the priority for
Returns
string

Definition at line 292 of file generateSitemap.php.

References MWNamespace\isSubject().

Referenced by priority().

◆ indexEntry()

GenerateSitemap::indexEntry (   $filename)

Return the XML for a single sitemap indexfile entry.

Parameters
string$filenameThe filename of the sitemap file
Returns
string

Definition at line 486 of file generateSitemap.php.

References PROTO_CANONICAL, and wfGetServerUrl().

Referenced by main().

◆ main()

◆ open()

GenerateSitemap::open (   $file,
  $flags 
)

gzopen() / fopen() wrapper

Parameters
string$file
string$flags
Returns
resource

Definition at line 400 of file generateSitemap.php.

Referenced by main().

◆ openFile()

GenerateSitemap::openFile ( )

Return the XML required to open a sitemap file.

Returns
string

Definition at line 509 of file generateSitemap.php.

References xmlHead(), and xmlSchema().

Referenced by generateLimit(), and main().

◆ openIndex()

GenerateSitemap::openIndex ( )

Return the XML required to open a sitemap index file.

Returns
string

Definition at line 476 of file generateSitemap.php.

References xmlHead(), and xmlSchema().

Referenced by main().

◆ priority()

GenerateSitemap::priority (   $namespace)

Get the priority of a given namespace.

Parameters
int$namespaceThe namespace to get the priority for
Returns
string

Definition at line 280 of file generateSitemap.php.

References guessPriority().

Referenced by generateLimit(), and main().

◆ setNamespacePriorities()

◆ sitemapFilename()

GenerateSitemap::sitemapFilename (   $namespace,
  $count 
)

Get a sitemap filename.

Parameters
int$namespace
int$count
Returns
string

Definition at line 447 of file generateSitemap.php.

References $ext.

Referenced by main().

◆ write()

GenerateSitemap::write ( $handle,
  $str 
)

gzwrite() / fwrite() wrapper

Parameters
resource&$handle
string$str

Definition at line 416 of file generateSitemap.php.

Referenced by main().

◆ xmlHead()

GenerateSitemap::xmlHead ( )

Return the XML required to open an XML file.

Returns
string

Definition at line 458 of file generateSitemap.php.

Referenced by openFile(), and openIndex().

◆ xmlSchema()

GenerateSitemap::xmlSchema ( )

Return the XML schema being used.

Returns
string

Definition at line 467 of file generateSitemap.php.

Referenced by openFile(), and openIndex().

Member Data Documentation

◆ $compress

bool GenerateSitemap::$compress

Whether or not to use compression.

Definition at line 80 of file generateSitemap.php.

◆ $dbr

object GenerateSitemap::$dbr

A database replica DB object.

Definition at line 122 of file generateSitemap.php.

◆ $file

resource GenerateSitemap::$file

A resource pointing to a sitemap file.

Definition at line 136 of file generateSitemap.php.

◆ $findex

resource GenerateSitemap::$findex

A resource pointing to the sitemap index file.

Definition at line 129 of file generateSitemap.php.

◆ $fspath

string GenerateSitemap::$fspath

The path to prepend to the filename.

Definition at line 65 of file generateSitemap.php.

◆ $identifier

string GenerateSitemap::$identifier
private

Identifier to use in filenames, default $wgDBname.

Definition at line 143 of file generateSitemap.php.

◆ $limit

array GenerateSitemap::$limit = []

The number of entries to save in each sitemap file.

Definition at line 94 of file generateSitemap.php.

◆ $namespaces

array GenerateSitemap::$namespaces = []

A one-dimensional array of namespaces in the wiki.

Definition at line 108 of file generateSitemap.php.

◆ $priorities

array GenerateSitemap::$priorities = []

Key => value entries of namespaces and their priorities.

Definition at line 101 of file generateSitemap.php.

◆ $size_limit

int GenerateSitemap::$size_limit

The maximum size of a sitemap file.

http://www.sitemaps.org/faq.php#faq_sitemap_size

Definition at line 58 of file generateSitemap.php.

◆ $skipRedirects

bool GenerateSitemap::$skipRedirects

Whether or not to include redirection pages.

Definition at line 87 of file generateSitemap.php.

◆ $timestamp

string GenerateSitemap::$timestamp

When this sitemap batch was generated.

Definition at line 115 of file generateSitemap.php.

◆ $url_limit

int GenerateSitemap::$url_limit

The maximum amount of urls in a sitemap file.

http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd

Definition at line 49 of file generateSitemap.php.

◆ $urlpath

string GenerateSitemap::$urlpath

The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath.

Definition at line 73 of file generateSitemap.php.

◆ GS_MAIN

const GenerateSitemap::GS_MAIN = -2

Definition at line 39 of file generateSitemap.php.

◆ GS_TALK

const GenerateSitemap::GS_TALK = -1

Definition at line 40 of file generateSitemap.php.


The documentation for this class was generated from the following file: