method.install.php

<?php
#----------------------------------------------------------------------
# Module: Booker - a resource booking module
# Method: install
#----------------------------------------------------------------------
# See file Booker.module.php for full details of copyright, licence, etc.
#----------------------------------------------------------------------

$taboptarray = array(
 'mysql' => 'ENGINE MyISAM CHARACTER SET utf8 COLLATE utf8_general_ci',
 'mysqli' => 'ENGINE MyISAM CHARACTER SET utf8 COLLATE utf8_general_ci');
$dict = NewDataDictionary($db);
$pre = cms_db_prefix();
$errmsg = 'Installation failure'; //no translation
/*
items (i.e. groups and resources) table schema:
NOTE (almost) no NOTNULL/default values, so inheritance can be determined
NOTE: changes here must be reflected in action.openitem, Import::ImportItems(), Export::ExportItems()
 item_id:
 alias:
 name:
 description:
 keywords: comma-separated descriptors/tags for similarity scans
 pickname: for a group - name to display in resource-picker
 membersname: for a group - generic plural member-descriptor e.g. 'members'
 image: filename or ,-separated series of names, uploaded file(s)
 available: interval-descriptor string or empty for always-available
 pickthis: whether to display this item in resource-picker
 pickmembers: for a group - whether to display its members in resource-picker
 slottype: enumerator for interval of a single booking per TimeIntervals()
 slotcount: count of slottype intervals which, together with slottype, defines length of a bookings
 bookcount: max. slots per booking, 0 = no limit, 1 = no need for booking end choice
 bookertell: whether to (try to) send confirmation message to booker, default inherit
 leadtype: enumerator for interval used for max. lead-time for bookings
 leadcount: count of leadtype intervals which, together with leadtype, defines max. lead-time for (no-repeat) bookings
 rationcount: max. pending bookings for any specific booker
 keeptype: enumerator for interval used for max. retention-time for past bookings
 keepcount: count of keeptype intervals which, together with keeptype, defines max. retention-time for bookings history
 grossfees: whether recorded fees include sales tax, default true
 taxrate: sales tax rate, 0..1 assumed to be a proportion, >=1 assumed percent
 latitude: for sun-related calcs, accurate to ~1km
 longitude: ditto
 timezone: for date/time offsets & calcs
 dateformat: how to display dates
 timeformat: how to display times
 listformat: Booker::LIST* enum representing default layout for list-style bookings display
 stylesfile: specific (uploaded) css file
 approver: identifier of whoever handles booking requests for this item
 approvercontact: contact info for the approver
 approvertell: whether to (try to) send notice to approver about submitted/recorded booking, default inherit
 smsprefix: country-code to be prepended to sms messages when needed
 smspattern: regex for determining whether approvercontact is a phone suitable for sms messages (no whitespace, before country-prefix)
 formiface: for future use e.g. module name, properties to use, for custom booking-request form
 paymentiface: for future use e.g. module name, gateway name, properties to use
 feugroup: id of group of whose members are authorised to make 'direct' (un-mediated) bookings
 owner: uid of the contact-person for the item, or 0 if there's no such person
 cleargroup: boolean whether to clear data for item when (sole) parent-group data are cleared, default false
 subgrpalloc: Booker::ALLOC* enum for sub-group allocation protocol
 subgrpdata: internal use, for working with subgrpalloc
 active: enum: 0 never; 1 always; 2 inherit (see also: available); -1 deletion pending while historical data needed
*/
$fields = '
item_id I(4) KEY,
alias C(24),
name C(64),
description X,
keywords C(256),
pickname C(48),
membersname C(32),
image C(128),
available C(128),
pickthis I(1) DEFAULT 1,
pickmembers I(1) DEFAULT 0,
slottype I(1) DEFAULT 1,
slotcount I(1) DEFAULT 0,
leadtype I(1) DEFAULT 2,
leadcount I(1) DEFAULT 0,
keeptype I(1) DEFAULT 5,
keepcount I(1) DEFAULT 0,
bookcount I(1) DEFAULT 0,
rationcount I(1) DEFAULT 0,
grossfees I(1) DEFAULT 1,
taxrate N(8.4),
latitude N(8.3),
longitude N(8.3),
timezone C(48),
dateformat C(12),
timeformat C(12),
listformat I(1),
stylesfile C(36),
approver C(64),
approvercontact C(128),
approvertell I(1) DEFAULT 1,
bookertell I(1) DEFAULT 1,
smsprefix C(8),
smspattern C(32),
formiface C(48),
paymentiface C(48),
feugroup I(8),
owner I(8),
cleargroup I(1) DEFAULT 0,
subgrpalloc I(1),
subgrpdata I(1) DEFAULT 0,
active I(1) DEFAULT 1,
bulletin B
';
$sqlarray = $dict->CreateTableSQL($this->ItemTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}

// sequences, for resource id's (1+) and group id's (MINGRPID+) in same table
$db->CreateSequence($this->ItemTable.'_seq'); //resource id's 1..MINGRPID-1
$db->CreateSequence($this->ItemTable.'_gseq', Booker::MINGRPID); //group id's start higher

// default group usable by all resources
$gid = $db->GenID($this->ItemTable.'_gseq');
$sql = 'INSERT INTO '.$this->ItemTable.' (item_id,name) VALUES (?,?)'; //TODO more fields
$db->Execute($sql, array($gid, $this->Lang('groupdefault')));

/*
group-relationships table schema:
 gid: unique identifier
 child: id of resource or group, indexed, not unique
 parent: id of group of which child is a member
 likeorder: order of children 'likeness' in parent
 proximity: order of multi-parents in all of which child is a member
*/
$fields = '
gid I AUTO KEY,
child I(2) NOTNULL DEFAULT 0,
parent I(2) NOTNULL DEFAULT 0,
likeorder I(2) NOTNULL DEFAULT 1,
proximity I(2) NOTNULL DEFAULT 1
';
$sqlarray = $dict->CreateTableSQL($this->GroupTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
// index
$sqlarray = $dict->CreateIndexSQL('idx_'.$this->GroupTable, $this->GroupTable, 'child');
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}


/*
requests and non-repeated bookings-data table schema:
NB Booker\CSV::ImportBookings must conform to this
NB action.dobooking.php etc must conformed to this
 bkg_id: unique identifier
 booker_id: identifier
 item_id: resource or group identifier
 subgrpcount: 1 or count of group-resources
 lodged: UTC timestamp
 approved: UTC timestamp
 removed: UTC timestamp
 slotstart: UTC timestamp
 slotlen: seconds booked, NOT seconds-per-slot
 comment: string submitted as part of request
 fee: fee for the booking
 feepaid: amount actually paid for the booking
 status: one of the Booker::STAT* values
 statpay: enum Booker::STATFREE..STATMAXPAY
 active: enum/boolean 1, or 0 if booking has been deleted but historic data remain
 gatetransaction: payment-interface transaction identifier
//gatedata: payment-interface full data for the transaction
*/
$fields = '
bkg_id I(4) KEY,
booker_id I(4),
item_id I(4),
subgrpcount I(1) DEFAULT 1,
lodged I(8),
approved I(8),
removed I(8),
slotstart I(8),
slotlen I(4),
comment C(64),
fee N(8.2) DEFAULT 0.0,
feepaid N(8.2) DEFAULT 0.0,
status I(1) DEFAULT '.Booker::STATNONE.',
statpay I(1) DEFAULT '.Booker::STATFREE.',
active I(1) DEFAULT 1,
gatetransaction C(48)
';
//gatedata B
$sqlarray = $dict->CreateTableSQL($this->OnceTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
// sequence
$db->CreateSequence($this->OnceTable.'_seq');

/*
repeated bookings-data table schema:
 bkg_id: unique identifier
 booker_id: identifier
 item_id: resource or group id
 subgrpcount: no. of in-group resources to be processed per subgrpalloc
 lodged: UTC timestamp
 approved: UTC timestamp
 removed: UTC timestamp
 checkedfrom: UTC timestamp for start of first day for which actual bookings have been recoreded
 checkedto: UTC timestamp for start of day after last day for which actual bookings have been recoreded
 formula: interval-descriptor string
 fee: fee for the booking
 feepaid: amount actually paid for the booking
 status: one of the Booker::STAT* values
 statpay: enum Booker::STATFREE..STATMAXPAY
 active: enum/boolean 1, or 0 if booking has been deleted but historic data remain
 gatetransaction: transaction id reported by payment gateway
//gatedata: json data reported by payment gateway, encrypted
*/
$fields = '
bkg_id I(4) KEY,
booker_id I(4),
item_id I(4),
subgrpcount I(1) DEFAULT 1,
lodged I(8),
approved I(8),
removed I(8),
checkedfrom I(8) DEFAULT 0,
checkedto I(8) DEFAULT 0,
formula C(256),
fee N(8.2) DEFAULT 0.0,
feepaid N(8.2) DEFAULT 0.0,
status I(1) DEFAULT '.Booker::STATNONE.',
statpay I(1) DEFAULT '.Booker::STATFREE.',
active I(1) DEFAULT 1
gatetransaction C(48)
';
//gatedata B
$sqlarray = $dict->CreateTableSQL($this->RepeatTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}

/*
 bookings-display-data table schema:
 data_id: table key
 bkg_id: OnceTable/RepeatTable cross-referencer
 booker_id: BookerTable cross-referencer
 item_id: ItemTable cross-referencer
 slotstart: UTC timestamp start of booking
 slotlen: booking length (seconds)
 bulk: enum Booker::BULK* (0 single, 1 group, 20 repeat, 21 group-repeat)
 displayed: boolean whether to include the record in displayed bookings
*/
$fields = '
data_id I(4) NOT NULL,
bkg_id I(4),
booker_id I(4),
item_id I(4),
slotstart I(8),
slotlen I(4),
bulk I(1) DEFAULT 0,
displayed I(1) DEFAULT 1
';
$sqlarray = $dict->CreateTableSQL($this->DispTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
//indices
$sqlarray = $dict->CreateIndexSQL('idx1_'.$this->DispTable, $this->DispTable, 'data_id',
	array('UNIQUE'));
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
$sqlarray = $dict->CreateIndexSQL('idx2_'.$this->DispTable, $this->DispTable, 'slotstart');
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}

$db->CreateSequence($this->DispTable.'_seq');

/*
Fees for resource usage & related conditions
 fee_id:
 item_id: group/item to which the condition applies
 signature: identifier for cross-resource matching, raw crc32 hash of slottype.slotcount.fee.feecondition
 description: public info/help about the condition
 slottype: enumerator for interval covered by the payment, 0..5 per TimeIntervals() or -1 for fixed amount
 slotcount: count of slottype intervals which, together with slottype, defines length to which fee applies
 fee: rate or amount which applies when feecondition is satisfied
 feecondition: interval-descriptor or user-decriptor
 usercondition: string, numeric usergroup 0..9 or comma-seprated series of them or empty
 condorder: enum for display-order and fee-application-order
 active: boolean/enum whether to use this fee
NOTE changes to this field-structure must be replicated in the add-fee mechanism
in action.fees.php
*/
$fields = '
fee_id I(4) KEY,
item_id I(4),
signature I(4),
description C(64),
slottype I(1),
slotcount I(1),
fee N(8.2) DEFAULT 0.0,
feecondition C(128),
usercondition C(32),
condorder I(1) DEFAULT -1,
active I(1) DEFAULT 1
';
$sqlarray = $dict->CreateTableSQL($this->FeeTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
$db->CreateSequence($this->FeeTable.'_seq');

/**
payment credit table schema:
 pay_id: identifier
 booker_id: identifier
 when: UTC timestamp, when the record was created
 status: enum {CREDITADDED CREDITUSED CREDITEXPIRED}
 first: original credit added
 amount: original +/- all changes
*/
$fields = '
pay_id I(4) KEY,
booker_id I(4),
updated I(8),
status I(1) DEFAULT '.Booker::CREDITADDED.',
original B,
latest B
';
$sqlarray = $dict->CreateTableSQL($this->CreditTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
$db->CreateSequence($this->CreditTable.'_seq');

/*
bookers table schema:
 booker_id: table key
 name: identifier for display, and identity check if publicid==FALSE NB NULL if unused, to enable COALESCE
 publicid: login/username/account for 'registered' bookers
 address: email (maybe accept a post-address...) for general messaging and billing NB NULL if unused, to enable COALESCE
 phone: cell-phone number, preferred for messaging
 addwhen: UTC timestamp when this record added NB NULL if unused, to enable COALESCE
 type: combination of 10 generic types and permission-flags - see class.Userops
 displayclass: display-stying enum 1..Booker::USERSTYLES
 active: enum: 0 no; 1 yes; -1 deletion pending while historical data needed
*/
$fields = '
booker_id I(4) KEY,
name C(64),
publicid C(48),
address B,
phone B,
addwhen I(8),
type I(1) DEFAULT 0,
displayclass I(1) DEFAULT 1,
active I(1) DEFAULT 1
';
$sqlarray = $dict->CreateTableSQL($this->BookerTable, $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
$db->CreateSequence($this->BookerTable.'_seq');

/*
Data cache
 cache_id:
 keyword: key
 value: flattened value
 savetime: timestamp - UTC?
 lifetime: seconds
*/
$fields = '
cache_id I(2) AUTO KEY,
keyword C(48),
value B,
savetime I(8),
lifetime I(4)
';
$sqlarray = $dict->CreateTableSQL($pre.'module_bkr_cache', $fields, $taboptarray);
if ($sqlarray == FALSE || $dict->ExecuteSQLArray($sqlarray, FALSE) != 2) {
	return $errmsg;
}
//this is not for table-data content (which is auto-numbered)
$db->CreateSequence($pre.'module_bkr_cache_seq');

// permissions
$this->CreatePermission($this->PermStructName, $this->Lang('perm_module')); //Booker Module Admin
// bookings only
$this->CreatePermission($this->PermAdminName, $this->Lang('perm_admin')); //Booker Admin
$this->CreatePermission($this->PermEditName, $this->Lang('perm_edit')); //Booker Modify
$this->CreatePermission($this->PermSeeName, $this->Lang('perm_view')); //Booker View
//resources/groups
$this->CreatePermission($this->PermAddName, $this->Lang('perm_add'));
$this->CreatePermission($this->PermDelName, $this->Lang('perm_delete'));
$this->CreatePermission($this->PermModName, $this->Lang('perm_modify'));
//bookers
$this->CreatePermission($this->PermPerName, $this->Lang('perm_booker'));

// create preferences NOTE most names correspond to a column-name in items-table i.e. inheritable property
$this->SetPreference('approver', '');
$this->SetPreference('approvercontact', '');
$this->SetPreference('approvertell', 1);
$this->SetPreference('bulletin', '');
$this->SetPreference('authcontext', ''); //NOT in items table
$this->SetPreference('available', ''); //always available
$this->SetPreference('bookcount', 0); //book any no. of slots
$this->SetPreference('bookertell', 1);
$this->SetPreference('cleargroup', 0);	//delete items in group when group is deleted (admin)
$this->SetPreference('exportencoding', 'UTF-8'); //preference-only, not an items-table field
$this->SetPreference('exportfile', 0); //preference-only, not an items-table field
$this->SetPreference('fee', 0.0);
$this->SetPreference('feecondition', ''); //empty = always used
$this->SetPreference('feugroup', 0);
$this->SetPreference('formiface', ''); //data for custom request-form
$this->SetPreference('grossfees', 1);
$this->SetPreference('keepcount', 0);
$this->SetPreference('keeptype', 8); //year-index per TimeIntervals()
$this->SetPreference('latitude', 0.0);
$this->SetPreference('longitude', 0.0);
$this->SetPreference('taxrate', 0.0);
$this->SetPreference('leadcount', 0);
$this->SetPreference('leadtype', 3); //week-index per TimeIntervals()
$this->SetPreference('listformat', Booker::LISTSU);
$this->SetPreference('membersname', $this->Lang('members'));
$this->SetPreference('minpay', 1.0); //in whatever currency is used
$this->SetPreference('owner', 0); //each resource/group may have a specific owner/contact
$this->SetPreference('pagerows', 10); //page-length of admin bookings-data view
$this->SetPreference('paymentiface', ''); //data for payment-processing
$this->SetPreference('rationcount', 0);
$this->SetPreference('showrange', 1); //week-index per DisplayIntervals(), default bookings-display-period
$this->SetPreference('slotcount', 1);
$this->SetPreference('slottype', 1); //hour-index per TimeIntervals()
$this->SetPreference('smspattern', '^\d[ \d]{6,15}$');
$this->SetPreference('smsprefix', ''); //TODO func(timezone)
$this->SetPreference('stripexport', 0);
$this->SetPreference('stylesfile', '');
$this->SetPreference('subgrpalloc', Booker::ALLOCNONE);
$this->SetPreference('timeformat', 'G:i'); //default date/time format string
//for email address checking by mailcheck.js
$this->SetPreference('domains', ''); //for initial check
$this->SetPreference('subdomains', ''); //for secondary check
$this->SetPreference('topdomains', 'biz,co,com,edu,gov,info,mil,name,net,org'); //for final check

$t = 'nQCeESKBr99A';
$this->SetPreference($t, hash('sha256', $t.microtime()));
//$t = some random string;
//$t = sprintf(base64_decode('U3VjayAlcyB1cCwgY3JhY2tlcnM='),$t);
$cfuncs = new Booker\Crypter($this);
$cfuncs->encrypt_preference('masterpass', base64_decode('U3VjayBpdCB1cCwgY3JhY2tlcnMh'));

$format = get_site_preference('defaultdateformat');
if ($format) {
	$strftokens = array(
	// Day - no strf eq : S
	'a' => 'D', 'A' => 'l', 'd' => 'd', 'e' => 'j', 'j' => 'z', 'u' => 'N', 'w' => 'w',
	// Week - no date eq : %U, %W
	'V' => 'W',
	// Month - no strf eq : n, t
	'b' => 'M', 'B' => 'F', 'm' => 'm',
	// Year - no strf eq : L; no date eq : %C, %g
	'G' => 'o', 'y' => 'y', 'Y' => 'Y',
	// Full Date / Time - no strf eq : c, r; no date eq : %c
	's' => 'U', 'D' => 'j/n/y', 'F' => 'Y-m-d', 'x' => 'j F Y'
	);
	$format = str_replace('%', '', $format);
	$parts = explode(' ', $format);
	foreach ($parts as $i => $fmt) {
		if (array_key_exists($fmt, $strftokens)) {
			$parts[$i] = $strftokens[$fmt];
		} else {
			unset($parts[$i]);
		}
	}
	$format = implode(' ', $parts);
} else {
	$format = 'd F y';
}

$this->SetPreference('dateformat', $format); //default date/time format string

if (date_default_timezone_get()) {
	$zone = date_default_timezone_get();
} elseif (!empty($config['timezone'])) {
	$zone = $config['timezone'];
} else {
	$zone = ini_get('date.timezone');
	if ($zone == FALSE) {
		$zone = 'Europe/London';
	}//default to GMT
}
$this->SetPreference('timezone', $zone);	//default zone for time calcs

//place for file uploads, not an inheritable item-property
$ud = $this->GetName();
if ($ud) {
	$fp = $config['uploads_path'];
	if ($fp && is_dir($fp)) {
		$fp = cms_join_path($fp, $ud);
		if ($fp && !is_dir($fp)) {
			if (!mkdir($fp, 0777, TRUE)) { //don't know how server is running!
				$ud = '';
			}
		}
	}
}
$this->SetPreference('uploadsdir', $ud);
//site-page alias for use in RegisterRoute, not an inheritable item-property
$this->SetPreference('sitepage', 'booker');

// enable FormBuilder-module custom processing
$ob = cms_utils::get_module('FormBuilder');
if (is_object($ob)) {
	$fp = $config['root_path'];
	if ($fp && is_dir($fp)) {
		//this->GetModulePath() N/A prior to installation
		$src = cms_join_path($fp, 'modules', 'Booker', 'lib', 'DispositionBookingRequest.class.php');
		if (is_file($src)) {
			$dest = cms_join_path($ob->GetModulePath, 'classes');
			if (copy($src, $dest)) {
				//TODO remember
			} else {
				//TODO handle error - NO FRONTEND BOOKINGS
			}
		} else {
			echo 'File path error';
//TODO handle error - NO FRONTEND BOOKINGS
		}
	}
	unset($ob);
}

// put mention into the admin log
$this->Audit(0, $this->Lang('fullname'), $this->Lang('audit_installed', $this->GetVersion()));