Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?php
/*********************************************************************
class.i18n.php
Internationalization and localization helpers for osTicket
Peter Rotich <peter@osticket.com>
Jared Hancock <jared@osticket.com>
Copyright (c) 2006-2013 osTicket
http://www.osticket.com
Released under the GNU General Public License WITHOUT ANY WARRANTY.
See LICENSE.TXT for details.
vim: expandtab sw=4 ts=4 sts=4:
**********************************************************************/
require_once INCLUDE_DIR.'class.error.php';
require_once INCLUDE_DIR.'class.yaml.php';
require_once INCLUDE_DIR.'class.config.php';
class Internationalization {
// Languages in order of decreasing priority. Always use en_US as a
// fallback
var $langs = array('en_US');
function Internationalization($language=false) {
if ($language)
array_unshift($this->langs, $language);
}
function getTemplate($path) {
return new DataTemplate($path, $this->langs);
}
/**
* Loads data from the I18N_DIR for the target language into the
* database. This is intended to be done at the time of installation;
* however, care should be taken in this process to ensure that the
* process could be repeated if an administrator wanted to change the
* system language and reload the data.
*/
function loadDefaultData() {
# notrans -- do not translate the contents of this array
'email_template_group.yaml' => 'EmailTemplateGroup',
'department.yaml' => 'Dept',
'sla.yaml' => 'SLA',
'form.yaml' => 'DynamicForm',
// Note that department, sla, and forms are required for
// help_topic
'help_topic.yaml' => 'Topic',
'filter.yaml' => 'Filter',
'team.yaml' => 'Team',
'group.yaml' => 'Group',
'file.yaml' => 'AttachmentFile',
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
);
$errors = array();
foreach ($models as $yaml=>$m)
if ($objects = $this->getTemplate($yaml)->getData())
foreach ($objects as $o)
// Model::create($o)
call_user_func_array(
array($m, 'create'), array($o, &$errors));
// Priorities
$priorities = $this->getTemplate('priority.yaml')->getData();
foreach ($priorities as $name=>$info) {
$sql = 'INSERT INTO '.PRIORITY_TABLE
.' SET priority='.db_input($name)
.', priority_desc='.db_input($info['priority_desc'])
.', priority_color='.db_input($info['priority_color'])
.', priority_urgency='.db_input($info['priority_urgency']);
db_query($sql);
}
// Configuration
if (($tpl = $this->getTemplate('config.yaml'))
&& ($data = $tpl->getData())) {
foreach ($data as $section=>$items) {
$_config = new Config($section);
foreach ($items as $key=>$value)
$_config->set($key, $value);
}
}
// Pages
$_config = new OsticketConfig();
foreach (array('landing','thank-you','offline') as $type) {
$tpl = $this->getTemplate("templates/page/{$type}.yaml");
if (!($page = $tpl->getData()))
continue;
$sql = 'INSERT INTO '.PAGE_TABLE.' SET type='.db_input($type)
.', name='.db_input($page['name'])
.', body='.db_input($page['body'])
.', lang='.db_input($tpl->getLang())
.', notes='.db_input($page['notes'])
.', created=NOW(), updated=NOW(), isactive=1';
if (db_query($sql) && ($id = db_insert_id()))
$_config->set("{$type}_page_id", $id);
}
// Canned response examples
if (($tpl = $this->getTemplate('templates/premade.yaml'))
&& ($canned = $tpl->getData())) {
foreach ($canned as $c) {
if (($id = Canned::create($c, $errors))
$premade = Canned::lookup($id);
foreach ($c['attachments'] as $a) {
$premade->attachments->save($a, false);
}
}
}
}
// Email templates
// TODO: Lookup tpl_id
$tpl = EmailTemplateGroup::lookup(1);
foreach ($tpl->all_names as $name=>$info) {
if (($tp = $this->getTemplate("templates/email/$name.yaml"))
&& ($t = $tp->getData())) {
$t['tpl_id'] = $tpl->getId();
$t['code_name'] = $name;
$id = EmailTemplate::create($t, $errors);
if ($id && ($template = EmailTemplate::lookup($id))
&& ($ids = Draft::getAttachmentIds($t['body'])))
$template->attachments->upload($ids, true);
}
}
}
}
class DataTemplate {
// Base folder for default data and templates
var $base = I18N_DIR;
var $filepath;
var $data;
/**
* Searches for the files matching the template in the order of the
* received languages. Once matched, the language is captured so that
* template itself does not have to keep track of the language for which
* it is defined.
*/
function DataTemplate($path, $langs=array('en_US')) {
foreach ($langs as $l) {
if (file_exists("{$this->base}/$l/$path")) {
$this->lang = $l;
$this->filepath = Misc::realpath("{$this->base}/$l/$path");
break;
}
}
}
function getData() {
if (!isset($this->data) && $this->filepath)
$this->data = YamlDataParser::load($this->filepath);
// TODO: If there was a parsing error, attempt to try the next
// language in the list of requested languages
return $this->data;
}
function getLang() {
return $this->lang;
}
}
?>