ValidateGrabber(3pm)

✨ NAME ✨

XMLTV::ValidateGrabber — bestie, this is the module that validates an XMLTV grabber 💅 (it's a Perl 3pm page, if the header didn't already spoil it 🎀)

---

🌸 DESCRIPTION 🌸

okay so. This is a utility library that checks whether a grabber actually does what it says it does — like, it verifies that the grabber properly implements the capabilities described at:

http://wiki.xmltv.org/index.php/XmltvCapabilities

The way it works is so smart actually: ValidateGrabber first asks the grabber which capabilities it claims to support, and then it goes and validates that it actually does support these capabilities. vibe check on the grabber's whole personality 😭 it says one thing and this module finds out if it's telling the truth.

---

🦋 EXPORTED FUNCTIONS 🦋

All these functions are exported on demand (no cap, they show up when you call them ✨).

💖 ConfigureGrabber 💖

ConfigureGrabber( "./tv_grab_new", "./tv_grab_new.conf" )

💜 ValidateGrabber 💜

Runs the whole validation thing for a grabber. main character energy fr fr.

ValidateGrabber( "tv_grab_new", "./tv_grab_new", "./tv_grab_new.conf",
                 "/tmp/new_", "./blib/share", 0 )

ValidateGrabber takes the following parameters:

• a short name for the grabber. This is only used when printing error messages, bestie.
• the command to run the grabber.
• the name of a configuration-file for the grabber.
• a file-prefix that is added to all output-files.
• a path to a directory with metadata for the grabber. This path is passed to the grabber via the --share option if the grabber supports the capability 'share'. undef if no --share parameter shall be used.
• a boolean specifying if the --cache parameter shall be used for grabbers that support the 'cache' capability.

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

• noparamcheck — The grabber accepts any parameter without returning an error-code. 🚩
• noversion — The grabber returns an error when run with --version.
• nodescription — The grabber returns an error when run with --description.
• nocapabilities — The grabber returns an error when run with --capabilities.
• nobaseline — The grabber does not list 'baseline' as one of its supported capabilities.
• nomanualconfig — The grabber does not list 'manualconfig' as one of its supported capabilities.
• noconfigurationfile — The specified configuration-file does not exist. 💀
• graberror — The grabber returned with an error-code when asked to grab data.
• notquiet — The grabber printed something to STDERR even though the --quiet option was used. not the quiet slay we were hoping for 😭
• outputdiffers — The grabber produced different output when called with different combinations of --output and --quiet.
• caterror — tv_cat returned an error-code when we asked it to process the output from the grabber.
• sorterror — tv_sort found errors in the data generated by the grabber. Probably overlapping programmes.
• notadditive — grabbing data for tomorrow first and then for the day after tomorrow and concatenating them does not yield the same result as grabbing the data for tomorrow and the day after tomorrow at once.

Alsooo, heads up: the list of errors will contain error keywords from XMLTV::ValidateFile if the xmltv-file generated by the grabber was not valid. 👑

If no errors are found, an empty list is returned. periodt. clean. iconic. ✨

---

🎀 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.

---

okay bestie that's the whole page 🫶 this was written for perl v5.40.1, dated 2025-04-19, and it's the ValidateGrabber(3pm) page from User Contributed Perl Documentation 💖 go forth and validate those grabbers, no cap 🌈💅