match hyphens in doclink formatting removal

[bse.git] / schema / bse.sql

drop table if exists bse_tag_category_deps;
drop table if exists bse_tag_categories;
drop table if exists bse_tag_members;
drop table if exists bse_tags;
drop table if exists bse_coupon_tiers;
drop table if exists bse_coupons;

-- represents sections, articles
DROP TABLE IF EXISTS article;
CREATE TABLE article (
  id integer NOT NULL auto_increment,

  -- 0 for the entry page
  -- -1 for top-level sections (shown in side menu)
  parentid integer DEFAULT '0' NOT NULL,

  -- the order to display articles in
  -- used for ordering sibling articles
  displayOrder integer not NULL default 0,
  title varchar(255) DEFAULT '' NOT NULL,
  titleImage varchar(64) not null,
  body longtext NOT NULL,

  -- thumbnail image
  thumbImage varchar(64) not null default '',
  thumbWidth integer not null,
  thumbHeight integer not null,

  -- position of first image for this article
  imagePos char(2) not null,
  `release` datetime DEFAULT '1990-01-01 00:00:00' NOT NULL,
  expire datetime DEFAULT '2999-12-31 23:59:59' NOT NULL,
  keyword varchar(255) not null default '',

  -- the template in $TMPLDIR used to generate this as HTML
  template varchar(127) DEFAULT '' NOT NULL,

  -- a link to the page generated for this article
  -- if this is blank then no page is generated
  -- this is combined with the base of the site to get the file
  -- written to during generation
  link varchar(255) not null,
  admin varchar(64) not null,

  -- if there are more child articles than this, display links/summaries
  -- if the same of fewer, embed the articles
  -- the template can ignore this
  threshold integer not null default 3,

  -- the length of summary to display for this article
  summaryLength smallint(5) unsigned DEFAULT '200' NOT NULL,

  -- the class whose generate() method generates the page
  generator varchar(40) not null default 'article',

  -- the level of the article, 1 for top-level
  level smallint not null,

  -- for listed:
  -- 0 - don't list
  -- 1 - list everywhere
  -- 2 - list in sections, but not on the menu
  listed smallint not null default 1,
  -- date last modified
  lastModified datetime not null,

  -- flags specified via the config file
  -- used by code and templates
  flags varchar(80) not null default '',

  -- custom fields for local usage
  customDate1 datetime null,
  customDate2 datetime null,

  customStr1 varchar(255) null,
  customStr2 varchar(255) null,

  customInt1 integer null,
  customInt2 integer null,
  customInt3 integer null,
  customInt4 integer null,

  -- added by adrian
  lastModifiedBy varchar(60) default '' not null,
  created datetime default '0000-00-00 00:00:00' not null,
  createdBy varchar(60) default '' not null,
  author varchar(255) default '' not null,
  pageTitle varchar(255) default '' not null,

  force_dynamic integer not null default 0,
  cached_dynamic integer not null default 0,
  inherit_siteuser_rights integer not null default 1,

  metaDescription varchar(255) default '' not null,
  metaKeywords varchar(255) default '' not null,

  -- x just so we don't get a name issue with product
  summaryx text default '' not null,

  -- added by adrian
  -- filter menu value in allkids_of iterators
  menu smallint(5) not null default 0,

  -- short title for menus  
  titleAlias varchar(60) not null default '',

  -- alias used to generate links
  linkAlias varchar(255) not null default '',

  category varchar(40) not null default '',
  
  PRIMARY KEY (id),

  -- if we keep id in the indexes MySQL will sometimes be able to
  -- perform a query using _just_ the index, without scanning through
  -- all our main records with their blobs
  -- Unfortunately MySQL can only do this on fixed-width columns
  -- other databases may not need the id in the index, and may also be
  -- able to handle the variable length columns in the index
  INDEX article_date_index (`release`,expire, id),
  INDEX article_displayOrder_index (displayOrder),
  INDEX article_parentId_index (parentId),
  INDEX article_level_index (level, id),
  INDEX article_alias(linkAlias)
);

#
# Table structure for table 'searchindex'
#

DROP TABLE IF EXISTS searchindex;
CREATE TABLE searchindex (
  id varbinary(200) DEFAULT '' NOT NULL,
  -- a comma-separated lists of article and section ids
  articleIds varchar(255) default '' not null,
  sectionIds varchar(255) default '' not null,
  scores varchar(255) default '' not null,
  PRIMARY KEY (id)
) engine=myisam;

#
# Table structure for table 'image'
#
DROP TABLE IF EXISTS image;
CREATE TABLE image (
  id mediumint(8) unsigned NOT NULL auto_increment,
  articleId integer not null,
  image varchar(255) DEFAULT '' NOT NULL,
  alt varchar(255) DEFAULT '[Image]' NOT NULL,
  width smallint(5) unsigned,
  height smallint(5) unsigned,
  url varchar(255),
  displayOrder integer not null default 0,
  name varchar(255) default '' not null,
  storage varchar(20) not null default 'local',
  src varchar(255) not null default '',
  ftype varchar(20) not null default 'img',

  PRIMARY KEY (id)
);

# used for session tracking with Apache::Session::MySQL
DROP TABLE IF EXISTS sessions;
CREATE TABLE sessions (
  id char(32) not null primary key,
  a_session blob,
  -- so we can age this table
  whenChanged timestamp
  -- note: an index on whenChanged would speed up only the rare case 
  -- of bse_session_clean.pl, think hard before adding an index
);

-- these share data with the article table
DROP TABLE IF EXISTS product;
create table product (
  -- fkey to article id
  articleId integer not null,

  summary varchar(255) not null,

  -- number of days it typically takes to supply this item
  leadTime integer not null default 0,

  -- prices are in cents
  retailPrice integer not null,
  wholesalePrice integer not null,

  -- amount of GST on this item
  gst integer not null,

  -- options that can be specified for this product
  options varchar(255) not null,

  subscription_id integer not null default -1,
  subscription_period integer not null default 0,
  subscription_usage integer not null default 3,
  subscription_required integer not null default -1,

  product_code varchar(80) not null,

  -- properties relevant to calculating shipping cost
  weight integer not null,
  length integer not null default 0,
  width integer not null default 0,
  height integer not null default 0,
  
  primary key(articleId)
);

-- order is a reserved word
-- I couldn't think of/find another word here
DROP TABLE IF EXISTS orders;
create table orders (
  id integer not null auto_increment,

  -- delivery address
  delivFirstName varchar(127) not null default '',
  delivLastName varchar(127) not null default '',
  delivStreet varchar(127) not null default '',
  delivSuburb varchar(127) not null default '',
  delivState varchar(40) not null default '',
  delivPostCode varchar(40) not null default '',
  delivCountry varchar(127) not null default 'Australia',

  -- billing address
  billFirstName varchar(127) not null default '',
  billLastName varchar(127) not null default '',
  billStreet varchar(127) not null default '',
  billSuburb varchar(127) not null default '',
  billState varchar(40) not null default '',
  billPostCode varchar(40) not null default '',
  billCountry varchar(127) not null default 'Australia',

  telephone varchar(80) not null default '',
  facsimile varchar(80) not null default '',
  emailAddress varchar(255) not null default '',
  
  -- total price
  total integer not null,	
  wholesaleTotal integer not null default 0,
  gst integer not null,
  
  orderDate datetime not null,
  
  -- credit card information
  ccNumberHash varchar(127) not null default '',
  ccName varchar(127) not null default '',
  ccExpiryHash varchar(127) not null default '',
  ccType varchar(30) not null,

  -- non-zero if the order was filled
  filled integer not null default 0,
  whenFilled datetime,
  whoFilled varchar(40) not null default '',

  -- if the order has been paid for
  paidFor integer not null default 0,
  paymentReceipt varchar(40),

  -- hard to guess identifier
  randomId varchar(40),

  -- order was cancelled
  cancelled integer not null default 0,

  -- user id of the person who made the order
  -- an empty string if there's no user
  userId varchar(40) not null,

  paymentType integer not null default 0,

  -- intended for custom uses
  customInt1 integer null,
  customInt2 integer null,
  customInt3 integer null,
  customInt4 integer null,
  customInt5 integer null,

  customStr1 varchar(255) null,
  customStr2 varchar(255) null,
  customStr3 varchar(255) null,
  customStr4 varchar(255) null,
  customStr5 varchar(255) null,

  instructions text not null default '',
  billTelephone varchar(80) not null default '',
  billFacsimile varchar(80) not null default '',
  billEmail varchar(255) not null default '',

  -- numeric id of the user who created this order, should correspond 
  -- to the user name in userId, -1 if user was not logged on
  siteuser_id integer,
  affiliate_code varchar(40) not null default '',

  shipping_cost integer not null default 0,

  delivMobile varchar(80) not null default '',
  billMobile varchar(80) not null default '',

  -- information from online credit card processing
  -- non-zero if we did online CC processing
  ccOnline integer not null default 0,
  -- non-zero if processing was successful
  ccSuccess integer not null default 0,
  -- receipt number
  ccReceipt varchar(80) not null default '',
  -- main status code (value depends on driver)
  ccStatus integer not null default 0,
  ccStatusText varchar(80) not null default '',
  -- secondary status code (if any)
  ccStatus2 integer not null default 0,
  -- card processor transaction identifier
  -- the ORDER_NUMBER for Inpho
  ccTranId varchar(40) not null default '',

  -- order was completed by the customer
  complete integer not null default 1,

  delivOrganization varchar(127) not null default '',
  billOrganization varchar(127) not null default '',

  delivStreet2 varchar(127) not null default '',
  billStreet2 varchar(127) not null default '',

  purchase_order varchar(80) not null default '',

  -- the description of the shipping method as per $courier->description
  shipping_method varchar(64) not null default '',

  -- the name of the shipping method as per $courier->name
  shipping_name varchar(40) not null default '',

  -- trace of the request and response
  shipping_trace text null,

  -- paypal stuff
  -- token from SetExpressCheckout
  paypal_token varchar(255) null,
  
  paypal_tran_id varchar(255) null,

  freight_tracking varchar(255) not null default '',

  stage varchar(20) not null default '',

  -- truncated credit card number
  ccPAN varchar(4) not null default '',

  -- true if the order was paid manually
  paid_manually integer not null default 0,

  coupon_id integer null,
  coupon_code_discount_pc real not null default 0,

  delivery_in integer null,

  primary key (id),
  index order_cchash(ccNumberHash),
  index order_userId(userId, orderDate),
  index order_coupon(coupon_id)
);

DROP TABLE IF EXISTS order_item;
create table order_item (
  id integer not null auto_increment,
  -- foreign key to product
  productId integer not null,

  -- foreign key to order
  orderId integer not null,
  
  -- how many :)
  units integer not null,

  -- unit prices
  price integer not null,
  wholesalePrice integer not null,
  gst integer not null,

  -- options (if any) specified on this item in the order
  options varchar(255) not null,

  customInt1 integer null,
  customInt2 integer null,
  customInt3 integer null,

  customStr1 varchar(255) null,
  customStr2 varchar(255) null,
  customStr3 varchar(255) null,

  -- transferred from the product
  title varchar(255) not null default '',
  summary varchar(255) not null default '',
  subscription_id integer not null default -1,
  subscription_period integer not null default 0,

  -- transferred from the subscription
  max_lapsed integer not null default 0,

  -- session for a seminar
  session_id integer not null default -1,

  product_code varchar(80) not null default '',

  tier_id integer null default null,

  primary key (id),
  index order_item_order(orderId, id)
) engine=InnoDB;

drop table if exists other_parents;
create table other_parents (
  id integer not null auto_increment,

  parentId integer not null,
  childId integer not null,

  -- order as seen from the parent
  parentDisplayOrder integer not null,
  -- order as seen from the child
  childDisplayOrder integer not null,

  `release` datetime default '0000-00-00 00:00:00' not null,
  expire datetime default '9999-12-31 23:59:59' not null,

  primary key(id),
  unique (parentId, childId),
  index (childId, childDisplayOrder)
);

-- initially we just do paid for files, later we may add unpaid for files
-- there's some database support here to support unpaid for files
-- but it won't be implemented yet
drop table if exists article_files;
create table article_files (
  id integer not null auto_increment,
  articleId integer not null,

  -- the name of the file as displayed
  displayName varchar(255) not null default '',

  -- the filename as stored in the repository
  filename varchar(80) not null default '',

  -- how big it is
  sizeInBytes integer not null,

  -- a description of the file
  description varchar(255) not null default '',

  -- content type
  contentType varchar(80) not null default 'application/octet-stream',

  -- used to control the order the files are displayed in
  displayOrder integer not null,

  -- if non-zero this item is for sale
  -- it has no public URL and can only be downloaded via a script
  forSale integer not null default 0,

  -- we try to make the browser download the file rather than display it
  download integer not null default 0,

  -- when it was uploaded
  whenUploaded datetime not null,

  -- user must be logged in to download this file
  requireUser integer not null default 0,

  -- more descriptive stuff
  notes text not null default '',

  -- identifier for the file for use with filelink[]
  name varchar(80) not null default '',

  hide_from_list integer not null default 0,

  storage varchar(20) not null default 'local',
  src varchar(255) not null default '',
  category varchar(20) not null default '',
  file_handler varchar(20) not null default '',

  primary key (id)
);

-- this now stores metadata for more than just files
drop table if exists bse_article_file_meta;
create table bse_article_file_meta (
  id integer not null auto_increment primary key,

  -- refers to article_files
  file_id integer not null,

  -- name of this metadata
  name varchar(20) not null,

  content_type varchar(80) not null default 'text/plain',
  value longblob not null,

  -- metadata specific to an application, not deleted when metadata is
  -- regenerated
  appdata integer not null default 0,

  -- owner type
  owner_type varchar(20) not null default 'bse_file',

  unique file_name(file_id, owner_type, name)
);

-- these are mailing list subscriptions
drop table if exists subscription_types;
create table subscription_types (
  id integer not null auto_increment,

  -- name as listed to users on the user options page, and as listed
  -- on the subscriptions management page
  name varchar(80) not null,

  -- the default title put into the article, and used for the article title 
  -- field when generating the article
  title varchar(64) not null,

  -- a description for the subscription
  -- used on user options page to give more info about a subscription
  description text not null,

  -- description of the frequency of subscriptions
  -- eg. "weekly", "Every Monday and Thursday"
  frequency varchar(127) not null,

  -- keyword field for the generated article
  keyword varchar(255) not null,

  -- do we archive the email to an article?
  archive integer not null default 1,

  -- template used when we build the article
  article_template varchar(127) not null,

  -- one or both of the following template needs to be defined
  -- if you only define the html template then the email won't be sent
  -- to users who only accept text emails
  -- template used for the HTML portion of the email
  html_template varchar(127) not null,

  -- template used for the text portion of the email
  text_template varchar(127) not null,

  -- which parent to put the generated article under
  -- can be 0 to indicate no article is generated
  parentId integer not null,

  -- the last time this was sent out
  lastSent datetime not null default '0000-00-00 00:00',

  -- if this is non-zero then the subscription is visible to users
  visible integer not null default 1,  
  
  primary key (id)
);

-- which lists users are subscribed to
drop table if exists subscribed_users;
create table subscribed_users (
  id integer not null auto_increment,
  subId integer not null,
  userId integer not null,
  primary key(id),
  unique (subId, userId)  
);

-- contains web site users
-- there will be a separate admin users table at some point
drop table if exists bse_siteusers;
create table bse_siteusers (
  id integer not null auto_increment,

  idUUID varchar(40) not null,

  userId varchar(40) not null,
  password varchar(255) not null,
  password_type varchar(20) not null default 'plain',

  email varchar(255) not null,

  whenRegistered datetime not null,
  lastLogon datetime not null,

  -- used to fill in the checkout form
  title varchar(127),
  name1 varchar(127),
  name2 varchar(127),
  street varchar(127),
  street2 varchar(127),
  suburb varchar(127),
  state varchar(40),
  postcode varchar(40),
  country varchar(127),
  telephone varchar(80),
  facsimile varchar(80),
  mobile varchar(80) not null default '',
  organization varchar(127),

  -- if this is non-zero, we have permission to send email to this
  -- user
  confirmed integer not null default 0,

  -- the confirmation message we send to a user includes this value
  -- in the confirmation url
  confirmSecret varchar(40) not null default '',

  -- non-zero if we sent a confirmation message
  waitingForConfirmation integer not null default 0,

  textOnlyMail integer not null,

  previousLogon datetime not null,

  -- used for shipping information on the checkout form
  delivTitle varchar(127),
  delivEmail varchar(255) not null default '',
  delivFirstName varchar(127) not null default '',
  delivLastName varchar(127) not null default '',
  delivStreet varchar(127) not null default '',
  delivStreet2 varchar(127) not null default '',
  delivSuburb varchar(127) not null default '',
  delivState varchar(40) not null default '',
  delivPostCode varchar(40) not null default '',
  delivCountry varchar(127) not null default '',
  delivTelephone varchar(80) not null default '',
  delivFacsimile varchar(80) not null default '',
  delivMobile varchar(80) not null default '',
  delivOrganization varchar(127),

  instructions text not null default '',

  adminNotes text not null default '',

  disabled integer not null default 0,

  flags varchar(80) not null default '',

  affiliate_name varchar(40) not null default '',

  -- for password recovery
  -- number of attempts today
  lost_today integer not null default 0,
  -- what today refers to
  lost_date date null,
  -- the hash the customer needs to supply to change their password
  lost_id varchar(32) null,

  customText1 text,
  customText2 text,
  customText3 text,
  customStr1 varchar(255),
  customStr2 varchar(255),
  customStr3 varchar(255),

  customInt1 integer,
  customInt2 integer,

  customWhen1 datetime,

  -- when the account lock-out (if any) ends
  lockout_end datetime,

  primary key (id),
  unique (userId),
  index (affiliate_name),
  unique (idUUID)
);

-- this is used to track email addresses that we've sent subscription
-- confirmations to
-- this is used to prevent an attacked creating a few hundred site users
-- and having the system send confirmation requests to those users
-- we make sure we only send one confirmation request per 48 hours
-- and a maximum of 3 unacknowledged confirmation requests
-- once the 3rd confirmation request is sent we don't send the user
-- any more requests - ever
--
-- each confirmation message also includes a blacklist address the 
-- recipient can use to add themselves to the blacklist
--
-- We don't have an unverified mechanism to add users to the blacklist
-- since someone could use this as a DoS.
--
-- Once we receive an acknowledgement from the recipient we remove them 
-- from this table.
drop table if exists email_requests;
create table email_requests (
  -- the table/row classes need this for now
  id integer not null auto_increment,

  # the actual email address the confirmation was sent to
  email varchar(127) not null,

  # the genericized email address
  genEmail varchar(127) not null,

  -- when the last confirmation email was sent
  lastConfSent datetime not null default '0000-00-00 00:00:00',

  -- how many confirmation messages have been sent
  unackedConfMsgs integer not null default 0,

  primary key (id),
  unique (email),
  unique (genEmail)
);

-- these are emails that someone has asked not to be subscribed to 
-- any mailing list
drop table if exists email_blacklist;
create table email_blacklist (
  -- the table/row classes need this for now
  id integer not null auto_increment,
  email varchar(127) not null,

  -- a short description of why the address was blacklisted
  why varchar(80) not null,

  primary key (id),
  unique (email)
);

drop table if exists admin_base;
create table admin_base (
  id integer not null auto_increment,
  type char not null,
  primary key (id)
);

drop table if exists admin_users;
create table admin_users (
  base_id integer not null,
  logon varchar(60) not null,
  name varchar(255) not null,
  password varchar(255) not null,
  perm_map varchar(255) not null,
  password_type varchar(20) not null default 'plain',

  -- when the account lock-out (if any) ends
  lockout_end datetime,

  primary key (base_id),
  unique (logon)
);

drop table if exists admin_groups;
create table admin_groups (
  base_id integer not null,
  name varchar(80) not null,
  description varchar(255) not null,
  perm_map varchar(255) not null,
  template_set varchar(80) not null default '',
  primary key (base_id),
  unique (name)
);

drop table if exists admin_membership;
create table admin_membership (
  user_id integer not null,
  group_id integer not null,
  primary key (user_id, group_id)
);

drop table if exists admin_perms;
create table admin_perms (
  object_id integer not null,
  admin_id integer not null,
  perm_map varchar(255),
  primary key (object_id, admin_id)
);

-- -- these are "product" subscriptions
drop table if exists bse_subscriptions;
create table bse_subscriptions (
  subscription_id integer not null auto_increment primary key,

  text_id varchar(20) not null,

  title varchar(255) not null,

  description text not null,

  max_lapsed integer not null,

  unique (text_id)
);

drop table if exists bse_user_subscribed;
create table bse_user_subscribed (
  subscription_id integer not null,
  siteuser_id integer not null,
  started_at date not null,
  ends_at date not null,
  max_lapsed integer not null,
  primary key (subscription_id, siteuser_id)
);

drop table if exists bse_siteuser_images;
create table bse_siteuser_images (
  siteuser_id integer not null,
  image_id varchar(20) not null,
  filename varchar(80) not null,
  width integer not null,
  height integer not null,
  bytes integer not null,
  content_type varchar(80) not null,
  alt varchar(255) not null,

  primary key(siteuser_id, image_id)
);

drop table if exists bse_locations;
create table bse_locations (
  id integer not null auto_increment,
  description varchar(255) not null,
  room varchar(40) not null,
  street1 varchar(255) not null,
  street2 varchar(255) not null,
  suburb varchar(255) not null,
  state varchar(80) not null,
  country varchar(80) not null,
  postcode varchar(40) not null,
  public_notes text not null,

  bookings_name varchar(80) not null,
  bookings_phone varchar(80) not null,
  bookings_fax varchar(80) not null,
  bookings_url varchar(255) not null,
  facilities_name varchar(255) not null,
  facilities_phone varchar(80) not null,

  admin_notes text not null,

  disabled integer not null default 0,

  primary key(id)
);

drop table if exists bse_seminars;
create table bse_seminars (
  seminar_id integer not null primary key,
  duration integer not null
);

drop table if exists bse_seminar_sessions;
create table bse_seminar_sessions (
  id integer not null auto_increment,
  seminar_id integer not null,
  location_id integer not null,
  when_at datetime not null,
  roll_taken integer not null default 0,

  primary key (id),
  unique (seminar_id, location_id, when_at),
  index (seminar_id),
  index (location_id)
);

drop table if exists bse_seminar_bookings;
create table bse_seminar_bookings (
  id integer not null auto_increment primary key,
  session_id integer not null,
  siteuser_id integer not null,
  roll_present integer not null default 0,

  options varchar(255) not null default '',
  customer_instructions text not null default '',
  support_notes text not null default '',

  unique(session_id, siteuser_id),
  index (siteuser_id)
);

drop table if exists bse_siteuser_groups;
create table bse_siteuser_groups (
  id integer not null auto_increment primary key,
  name varchar(80) not null
);

drop table if exists bse_siteuser_membership;
create table bse_siteuser_membership (
  group_id integer not null,
  siteuser_id integer not null,
  primary key(group_id, siteuser_id),
  index(siteuser_id)
);

drop table if exists bse_article_groups;
create table bse_article_groups (
  article_id integer not null,
  group_id integer not null,
  primary key (article_id, group_id)
);

drop table if exists sql_statements;
create table sql_statements (
  name varchar(80) not null primary key,
  sql_statement text not null
);

drop table if exists bse_wishlist;
create table bse_wishlist (
  user_id integer not null,
  product_id integer not null,
  display_order integer not null,
  primary key(user_id, product_id)
);

drop table if exists bse_product_options;
create table bse_product_options (
  id integer not null auto_increment primary key,
  product_id integer not null references product(productId),
  name varchar(255) not null,
  type varchar(10) not null,
  global_ref integer null,
  display_order integer not null,
  enabled integer not null default 0,
  default_value integer,
  index product_order(product_id, display_order)
) engine=innodb;

drop table if exists bse_product_option_values;
create table bse_product_option_values (
  id integer not null auto_increment primary key,
  product_option_id integer not null references bse_product_options(id),
  value varchar(255) not null,
  display_order integer not null,
  index option_order(product_option_id, display_order)
) engine=innodb;

drop table if exists bse_order_item_options;
create table bse_order_item_options (
  id integer not null auto_increment primary key,
  order_item_id integer not null references order_item(id),
  original_id varchar(40) not null,
  name varchar(40) not null,
  value varchar(40) not null,
  display varchar(80) not null,
  display_order integer not null,
  index item_order(order_item_id, display_order)
) engine=innodb;

drop table if exists bse_owned_files;
create table bse_owned_files (
  id integer not null auto_increment primary key,

  -- owner type, either 'U' or 'G'
  owner_type char not null,

  -- siteuser_id when owner_type is 'U'
  -- group_id when owner_type is 'G'
  owner_id integer not null,

  category varchar(20) not null,
  filename varchar(255) not null,
  display_name varchar(255) not null,
  content_type varchar(80) not null,
  download integer not null,
  title varchar(255) not null,
  body text not null,
  modwhen datetime not null,
  size_in_bytes integer not null,
  filekey varchar(80) not null default '',
  index by_owner_category(owner_type, owner_id, category)
);

drop table if exists bse_file_subscriptions;
create table bse_file_subscriptions (
  id integer not null,
  siteuser_id integer not null,
  category varchar(20) not null,

  index by_siteuser(siteuser_id),
  index by_category(category)
);

drop table if exists bse_file_notifies;
create table bse_file_notifies (
  id integer not null auto_increment primary key,
  owner_type char not null,
  owner_id integer not null,
  file_id integer not null,
  when_at datetime not null,
  index by_owner(owner_type, owner_id),
  index by_time(owner_type, when_at)
);

drop table if exists bse_file_access_log;
create table bse_file_access_log (
  id integer not null auto_increment primary key,
  when_at datetime not null,
  siteuser_id integer not null,
  siteuser_logon varchar(40) not null,

  file_id integer not null,
  owner_type char not null,
  owner_id integer not null,
  category varchar(20) not null,
  filename varchar(255) not null,
  display_name varchar(255) not null,
  content_type varchar(80) not null,
  download integer not null,
  title varchar(255) not null,
  modwhen datetime not null,
  size_in_bytes integer not null,

  index by_when_at(when_at),
  index by_file(file_id),
  index by_user(siteuser_id, when_at)
);

-- configuration of background tasks
drop table if exists bse_background_tasks;
create table bse_background_tasks (
  -- static, doesn't change at runtime
  -- string id of the task
  id varchar(20) not null primary key,

  -- description suitable for users
  description varchar(80) not null,

  -- module that implements the task, or
  modname varchar(80) not null default '',

  -- binary (relative to base) that implements the task and options
  binname varchar(80) not null default '',
  bin_opts varchar(255) not null default '',

  -- whether the task can be stopped
  stoppable integer not null default 0,

  -- bse right required to start it
  start_right varchar(40),

  -- dynamic, changes over time
  -- non-zero if running
  running integer not null default 0,

  -- pid of the task
  task_pid integer null,

  -- last exit code
  last_exit integer null,

  -- last time started
  last_started datetime null,

  -- last completion time
  last_completion datetime null,

  -- longer description - formatted as HTML
  long_desc text null
);

-- message catalog
-- should only ever be loaded from data - maintained like code
drop table if exists bse_msg_base;
create table bse_msg_base (
  -- message identifier
  -- codebase/subsystem/messageid (message id can contain /)
  -- eg. bse/edit/save/noaccess
  -- referred to as msg:bse/edit/save/noaccess
  -- in this table only, id can have a trailing /, and the description 
  -- refers to a description of message under that tree, eg
  -- "bse/" "BSE Message"
  -- "bse/edit/" "Article editor messages"
  -- "bse/siteuser/" "Member management messages"
  -- "bse/userreg/" "Member services"
  -- id, formatting, params are limited to ascii text
  -- description unicode
  id varchar(80) not null primary key,

  -- a semi-long description of the message, including any parameters
  description text not null,

  -- type of formatting if any to do on the message
  -- valid values are "none" and "body"
  formatting varchar(5) not null default 'none',

  -- parameter types, as a comma separated list
  -- U - user
  -- A - article
  -- M - member
  --   for any of these describe() is called, the distinction is mostly for
  --   the message editor preview
  -- S - scalar
  -- comma separation is for future expansion
  -- %{n}:printfspec
  -- is replaced with parameter n in the text
  -- so %2:d is the second parameter formatted as an integer
  -- %% is replaced with %
  params varchar(40) not null default '',

  -- non-zero if the text can be multiple lines
  multiline integer not null default 0
);

-- default messages
-- should only ever be loaded from data, though different priorities
-- for the same message might be loaded from different data sets
drop table if exists bse_msg_defaults;
create table bse_msg_defaults (
  -- message identifier
  id varchar(80) not null,

  -- language code for this message
  -- empty as the fallback
  language_code varchar(10) not null default '',

  -- priority of this message, lowest 0
  priority integer not null default 0,

  -- message text
  message text not null,

  primary key(id, language_code, priority)
);

-- admin managed message base, should never be loaded from data
drop table if exists bse_msg_managed;
create table bse_msg_managed (
  -- message identifier
  id varchar(80) not null,

  -- language code
  -- empty as the fallback
  language_code varchar(10) not null default '',

  message text not null,

  primary key(id, language_code)
);

-- admin user saved UI state
drop table if exists bse_admin_ui_state;
create table bse_admin_ui_state (
  id integer not null auto_increment primary key,
  user_id integer not null,
  name varchar(80) not null,
  val text not null
);

drop table if exists bse_audit_log;
create table bse_audit_log (
  id integer not null auto_increment primary key,
  when_at datetime not null,

  -- bse for core BSE code, add on code supplies something different
  facility varchar(20) not null default 'bse',

  -- shop, search, editor, etc
  component varchar(20) not null,

  -- piece of component, paypal, index, etc
  -- NOT a perl module name
  module varchar(20) not null,

  -- what the module what doing
  function varchar(40) not null,

  -- level of event: (stolen from syslog)
  --  emerg - the system is broken
  --  alert - something needing immediate action
  --  crit - critical problem
  --  error - error
  --  warning - warning, something someone should look at
  --  notice - notice, something significant happened, but not an error
  --  info - informational
  --  debug - debug
  -- Stored as numbers from 0 to 7
  level smallint not null,

  -- actor
  -- type of actor:
  --  S - system
  --  U - member
  --  A - admin
  actor_type char not null,
  actor_id integer null,

  -- object (if any)
  object_type varchar(40) null,
  object_id integer null,

  ip_address varchar(20) not null,  

  -- brief description
  msg varchar(255) not null,

  -- debug dump
  dump longtext null,

  index ba_when(when_at),
  index ba_what(facility, component, module, function)
);

-- a more generic file container
-- any future managed files belong here
drop table if exists bse_selected_files;
drop table if exists bse_files;
create table bse_files (
  id integer not null auto_increment primary key,

  -- type of file, used to lookup a behaviour class
  file_type varchar(20) not null,

  -- id of the owner
  owner_id integer not null,

  -- name stored as
  filename varchar(255) not null,

  -- name displayed as
  display_name varchar(255) not null,

  content_type varchar(255) not null,

  size_in_bytes integer not null,

  when_uploaded datetime not null,

  -- is the file public?
  is_public integer not null,

  -- name identifier for the file (where needed)
  name varchar(80) null,

  -- ordering
  display_order integer not null,

  -- where a user finds the file
  src varchar(255) not null,

  -- categories within a type
  category varchar(255) not null default '',

  -- for use with images
  alt varchar(255) null,
  width integer null,
  height integer  null,
  url varchar(255) null,

  description text not null,

  ftype varchar(20) not null default 'img',

  index owner(file_type, owner_id)
) engine = InnoDB;

-- a generic selection of files from a pool
create table bse_selected_files (
  id integer not null auto_increment primary key,

  -- who owns this selection of files
  owner_id integer not null,
  owner_type varchar(20) not null,

  -- one of the files
  file_id integer not null,

  display_order integer not null default -1,

  unique only_one(owner_id, owner_type, file_id)
) engine = InnoDB;

drop table if exists bse_price_tiers;
create table bse_price_tiers (
  id integer not null auto_increment primary key,

  description text not null,

  group_id integer null,

  from_date date null,
  to_date date null,

  display_order integer null null
) engine=innodb;

drop table if exists bse_price_tier_prices;

create table bse_price_tier_prices (
  id integer not null auto_increment primary key,

  tier_id integer not null,
  product_id integer not null,

  retailPrice integer not null,

  unique tier_product(tier_id, product_id)
) engine=InnoDB;

create table bse_tags (
  id integer not null auto_increment primary key,

  -- typically "BA" for BSE article
  owner_type char(2) not null,
  cat varchar(80) not null,
  val varchar(80) not null,

  unique cat_val(owner_type, cat, val)
);

create table bse_tag_members (
  id integer not null auto_increment primary key,

  -- typically BA for BSE article
  owner_type char(2) not null,
  owner_id integer not null,
  tag_id integer not null,

  unique art_tag(owner_id, tag_id),
  index by_tag(tag_id)
);

create table bse_tag_categories (
  id integer not null auto_increment primary key,

  cat varchar(80) not null,

  owner_type char(2) not null,

  unique cat(cat, owner_type)
);

create table bse_tag_category_deps (
  id integer not null auto_increment primary key,

  cat_id integer not null,

  depname varchar(160) not null,

  unique cat_dep(cat_id, depname)
);

drop table if exists bse_ip_lockouts;
create table bse_ip_lockouts (
  id integer not null auto_increment primary key,

  ip_address varchar(20) not null,

  -- S or A for site user or admin user lockouts
  type char not null,

  expires datetime not null,

  unique ip_address(ip_address, type)
) engine=innodb;

create table bse_coupons (
  id integer not null auto_increment primary key,

  code varchar(40) not null,

  description text not null,

  `release` date not null,

  expiry date not null,

  discount_percent real not null,

  campaign varchar(20) not null,

  last_modified datetime not null,

  untiered integer not null default 0,

  unique codes(code)
) engine=InnoDB;

create table bse_coupon_tiers (
  id integer not null auto_increment primary key,

  coupon_id integer not null,

  tier_id integer not null,

  unique (coupon_id, tier_id),

  foreign key (coupon_id) references bse_coupons(id)
    on delete cascade on update restrict,

  foreign key (tier_id) references bse_price_tiers(id)
    on delete cascade on update restrict
) engine=InnoDB;

alter table order_item add constraint tier_id
  foreign key (tier_id) references bse_price_tiers(id)
    on delete restrict on update restrict;