From School of CS Wiki
Jump to: navigation, search
Newsagent Logo.png
Author Chris Page
Contact Support
Repository github
Issue tracker github
OS Neutral (web based)
Will not work with IE8 or older
URL Newsagent


This section contains some notes regarding the importer system and the steps importer modules should follow.

General structure

The importer consists of a view/controller entrypoint module import (Newsagent::Import in blocks/Newsagent/, a base model module Newsagent::Importer in modules/Newsagent/ Newsagent::Importer dynamically loads subclasses (of the form Newsagent::Importer::<SourceName>, and here simply referred to as "sources" as a shorthand) to handle the importing of articles on a source-specific basic. Dynamic loading is done using through the system-wide Webperl::Modules::load_module(), and the source modules must implement the import_articles() method to do any work they need to do.

Invocation and execution flow

The importer is executed by loading the import module - no auth is needed for this module, and it can be used via http or https:<source> Here source can be one of:

  • all - indicates that the importer should load and run all sources that need to run.
  • a source name, corresponding to a row with a given shortname in the news_import_sources table to run a specific source's import.

The import module takes a number of steps:

  • it checks the source is valid
  • if the source if valid, it checks whether it is time to run the import for that source yet
  • if it is time, the source module is loaded and its import_articles() is called.

(when the <source> argument is all, the above three steps happen for each defined source)


  • gravatar Mbasscp2 [userbureaucratcomp23420editorhandbook-editlabhelpstaff-editsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPmNvbXAyMzQyMDxiciAvPmVkaXRvcjxiciAvPmhhbmRib29rLWVkaXQ8YnIgLz5sYWJoZWxwPGJyIC8+c3RhZmYtZWRpdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+]