Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xmltv::validatefile(3pm) [debian man page]

ValidateFile(3pm)					User Contributed Perl Documentation					 ValidateFile(3pm)

NAME

       XMLTV::ValidateFile - Validates an XMLTV file

DESCRIPTION

       Utility library that validates that a file is correct according to http://wiki.xmltv.org/index.php/XMLTVFormat.

EXPORTED FUNCTIONS

       All these functions are exported on demand.

       LoadDtd
	   Load the xmltv dtd. Takes a single parameter which is the name of the xmltv dtd file.

	   LoadDtd must be called before ValidateFile can be called.

       ValidateFile
	   Validate that a file is valid according to the XMLTV dtd and try to check that it contains valid information. ValidateFile takes a
	   filename as parameter and optionally also a day and an offset and prints error messages to STDERR.

	   ValidateFile returns a list of errors that it found with the file. Each error takes the form of a keyword:

	   ValidateFile checks the following:

	   notwell
	       The file is not well-formed XML.

	   notdtd
	       The file does not follow the XMLTV DTD.

	   unknownid
	       No channel-entry found for a channelid that is used in a programme-entry.

	   duplicatechannel
	       More than one channel-entry found for a channelid.

	   noprogrammes
	       No programme entries were found in the file.

	   channelnoprogramme
	       There are no programme entries for one of the channels listed with a channel-entry.

	   invalidid
	       An xmltvid does not look like a proper id, i.e. it does not  match /^[-a-zA-Z0-9]+(.[-a-zA-Z0-9]+)+$/.

	   noid
	       A programme-entry without an id was found.

	   emptytitle
	       A programme entry with an empty or missing title was found.

	   emptydescription
	       A programme entry with an empty desc-element was found. The desc-element shall be omitted if there is no description.

	   badstart
	       A programme entry with an invalid start-time was found.

	   badstop
	       A programme entry with an invalid stop-time was found.

	   badepisode
	       A programme entry with an invalid episode number was found.

	   badiso8859
	       The file is encoded in iso-8859 but contains characters that have no meaning in iso-8859 (or are control characters).  If it's
	       iso-8859-1 aka Latin 1 it might be some characters in windows-1252 encoding.

	   badutf8
	       The file is encoded in utf-8 but contains characters that look strange.	1) Mis-encoded single characters represented with
	       [EF][BF][BD] bytes 2) Mis-encoded single characters represented with [C3][AF][C2][BF][C2][BD] bytes 3) Mis-encoded single
	       characters in range [C2][80-9F]

	   If no errors are found, an empty list is returned.

BUGS

       It is currently necessary to specify the path to the xmltv dtd-file.  This should not be necessary.

COPYRIGHT

       Copyright (C) 2006 Mattias Holmlund.

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

perl v5.14.2							    2011-06-22							 ValidateFile(3pm)

Check Out this Related Man Page

Configure(3pm)						User Contributed Perl Documentation					    Configure(3pm)

NAME

       XMLTV::Configure - Configuration file handling for XMLTV grabbers

DESCRIPTION

       Utility library that helps grabbers read from configuration files and implement a configuration method that can be run from the command-
       line.

EXPORTED FUNCTIONS

       All these functions are exported on demand.

       LoadConfig
	   Takes the name of the configuration file to load as a parameter.

	   Returns a hashref with configuration fieldnames as keys. Note that the values of the hash are references to an array of values.

	   Example:
	     {
	       username => [ 'mattias' ],
	       password => [ 'xxx' ],
	       channel => [ 'svt1.svt.se', 'kanal5.se' ],
	       no_channel => ['svt2.svt.se' ],
	     }

	   Note that unselected options from a selectmany are collected in an entry named after the key with a prefix of 'no_'. See the channel
	   and no_channel entry in the example. They are the result of a selectmany with id=channel.

	   The configuration file must be in the format described in the file "ConfigurationFiles.txt". If the file does not exist or if the
	   format is wrong, LoadConfig returns undef.

       SaveConfig
	   Write a configuration hash in the format returned by LoadConfig to a file that can be loaded with LoadConfig. Takes two parameters, a
	   reference to a configuration hash and a filename.

	   Note that a grabber should normally never have to call SaveConfig. This is done by the Configure-method.

       Configure
	   Generates a configuration file for the grabber.

	   Takes three parameters: stagesub, listsub and the name of the configuration file.

	   stagesub shall be a coderef that takes a stage-name or undef and a configuration hashref as a parameter and returns an xml-string that
	   describes the configuration necessary for that stage.  The xml-string shall follow the xmltv-configuration.dtd.

	   listsub shall be a coderef that takes a configuration hash as returned by LoadConfig as the first parameter and an option hash as
	   returned by ParseOptions as the second parameter and returns an xml-string containing a list of all the channels that the grabber can
	   deliver data for using the supplied configuration. Note that the listsub shall not use any channel-configuration from the hashref.

COPYRIGHT

       Copyright (C) 2005 Mattias Holmlund.

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

perl v5.14.2							    2012-04-10							    Configure(3pm)
Man Page