Krang Technical Specification

This document describes the technical details of the Krang project at a high level. This document is neither exhaustive or particularly reliable as it is not frequently updated.

Modules

This section contains a catalogue all code modules to be written. The descriptions of these modules are kept brief, relying the module documentation to provide in depth treatment.

Core Systems

• Krang::Handler
  
Apache/mod_perl handler for Krang. Sets up the appropriate instance and passes the request to a Krang::CGI module. Also handles authentication.
• Krang::Session
  
Sessions in Krang maintain state between browser hits.
• Krang::DB
  
Responsible for managing connections to Krang databases. Also contains routines to create new databases. Any database convenience functions we create will live here.
• Krang::Conf
  
Provides access to the configuration file in conf/krang.conf.
• Krang::CGI
  
Base class for all CGI::Application modules which provide the web interface for Krang.

Element System

See the Krang Element System overview for more details.

• Krang::ElementLibrary
  
Responsible for loading and configuring sets of Element Classes contained in the Element Library.
• Krang::ElementClass
  
The base class for all Krang element classes. Provides the functionality that allows Krang::Element objects to accept user input, persist in the database and render in published documents.
• Krang::Element
  
Manages element data created through the story and category editors. Each Krang::Element object contains a reference to a Krang::ElementClass object which controls its behavior.
• Krang::CGI::ElementEditor
  
Provides the element editor web interface, used by Krang::CGI::Story and Krang::CGI::Category.

Stories

• Krang::Story
  
Krang story object API. Manages the creation, listing and storage of Story objects.
• Krang::CGI::StoryEditor
  
Provides the Story creation and editing interface.

Media

• Krang::Media
  
Krang media object API. Manages the creation, listing and storage of Media objects.
• Krang::CGI::MediaEditor
  
Provides the Media creation and editing interface.
• Krang::CGI::MediaBulkUpload
  
Provides the Media bulk upload interface, not including the virtual FTP server.

Templates

• Krang::Template
  
Krang template object API. Manages the creation, listing and storage of Template objects.
• Krang::CGI::TemplateEditor
  
Provides the Story creation and editing interface.

Contributors

• Krang::Contributor
  
Krang contributor object API. Manages the creation, listing and storage of contributors.
• Krang::CGI::Contributor
  
Allows users to manage contributors. Also provides run-modes for use by the Story and Media interfaces in picking contributors.

Workflow

• Krang::Publisher
  
Contains the code that runs the publish process for Stories and Media.
• Krang::CGI::Publisher
  
The publishing interface.
• Krang::Desk
  
API for Krang desks, contains methods for moving objects between desks.
• Krang::CGI::Desk
  
Desk interface module.
• Krang::CGI::Workspace
  
Manages My Workspace, which is a special kind of desk.

Category

• Krang::Category
  
Provides the API for Krang categories.
• Krang::CGI::Category
  
Provides the admin interface for categories.

Site

• Krang::Site
  
Provides the API for sites within Krang.
• Krang::CGI::Site
  
Provides the admin interface for sites.

Search

• Krang::HTMLPager
  
Provides paging for lists of items in Krang.

User

• Krang::User
  
Provides the API for Krang users.
• Krang::CGI::User
  
Provides the admin interface for users.
• Krang::CGI::Login
  
The login screen.

Permissions Groups

• Krang::Group
  
The core API for the user group system, which controls permissions.
• Krang::CGI::Group
  
Provides the admin interface for setting up user groups.

Logging and Error Handling

• Krang::Log
  
Provides unified logging services for all Krang processes with output going to logs/krang.log.
• Krang::History
  
Mantains a per-object log of important events for stories, media and template objects.
• Krang::CGI::Bugzilla
  
Provides an interface for filling out a bug report inside Krang, which will automatically collect all necessary state information.

Alerts

• Krang::Alert
  
The core alert API. Users can configure alerts to send them emails when certain events occur within Krang.
• Krang::CGI::Alert
  
User interface for creating alerts.

XML

• Krang::DataSet
  
Provides a XML import/export for all Krang objects.

FTP

• Krang::FTP::Server
  
Provides an FTP interface to templates and media for bulk operations using Net::FTPServer.

Programs

This list contains all command-line programs to be created for Krang. The main part of the logic for these programs will reside in the modules listed above.

• krang_install
  
Krang installation process.
• krang_upgrade
  
Krang installation process.
• krang_ctl
  
Script to start, stop and restart all of the Krang daemons in one operation.
• krang_scheduled
  
Daemon to handles Krang's scheduled tasks.
• krang_apachectl
  
Script to start, stop and restart Apache.
• krang_ftpd
  
Krang FTP daemon.
• krang_export
  
Export Krang data set (.kds) files.
• krang_import
  
Import Krang data set (.kds) files.
• krang_delete
  
Delete Krang objects the easy way.
• krang_publish
  
Script to publish stories and media.