includes/lang.php
author Dan
Wed, 23 Jul 2008 11:02:29 -0500
changeset 662 fcab604da9a7
parent 654 18dbf386d356
child 668 0631e4de5de6
permissions -rw-r--r--
Made grinding_halt() exit with status 1 for POSIX compatibility; jscompress.php utility now accepts non-CDN websites
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     1
<?php
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     2
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     3
/*
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     4
 * Enano - an open-source CMS capable of wiki functions, Drupal-like sidebar blocks, and everything in between
536
218a627eb53e Rebrand as 1.1.4 (Caoineag alpha 4)
Dan
parents: 519
diff changeset
     5
 * Version 1.1.4 (Caoineag alpha 4)
218a627eb53e Rebrand as 1.1.4 (Caoineag alpha 4)
Dan
parents: 519
diff changeset
     6
 * Copyright (C) 2006-2008 Dan Fuhry
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     7
 *
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     8
 * This program is Free Software; you can redistribute and/or modify it under the terms of the GNU General Public License
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
     9
 * as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    10
 *
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    11
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    12
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    13
 */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    14
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    15
/**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    16
 * Language class - processes, stores, and retrieves language strings.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    17
 * @package Enano
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    18
 * @subpackage Localization
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    19
 * @copyright 2007 Dan Fuhry
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    20
 * @license GNU General Public License
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    21
 */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    22
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    23
class Language
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    24
{
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    25
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    26
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    27
   * The numerical ID of the loaded language.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    28
   * @var int
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    29
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    30
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    31
  var $lang_id;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    32
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    33
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    34
   * The ISO-639-3 code for the loaded language. This should be grabbed directly from the database.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    35
   * @var string
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    36
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    37
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    38
  var $lang_code;
210
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    39
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    40
  /**
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    41
   * Used to track when a language was last changed, to allow browsers to cache language data
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    42
   * @var int
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    43
   */
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    44
  
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
    45
  var $lang_timestamp;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    46
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    47
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    48
   * Will be an object that holds an instance of the class configured with the site's default language. Only instanciated when needed.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    49
   * @var object
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    50
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    51
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    52
  var $default;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    53
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    54
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    55
   * The list of loaded strings.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    56
   * @var array
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    57
   * @access private
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    58
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    59
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    60
  var $strings = array();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    61
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    62
  /**
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    63
   * Switch for debug mode. If true, will show an asterisk after localized strings. This
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    64
   * can be useful if you're localizing a component and need to see what's already done.
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    65
   * @var bool
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    66
   */
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    67
  
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    68
  var $debug = false;
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    69
  
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
    70
  /**
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    71
   * Constructor.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    72
   * @param int|string Language ID or code to load.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    73
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    74
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    75
  function __construct($lang)
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    76
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    77
    global $db, $session, $paths, $template, $plugins; // Common objects
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    78
    
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
    79
    if ( defined('IN_ENANO_INSTALL') && ( !defined('ENANO_CONFIG_FETCHED') || ( defined('IN_ENANO_UPGRADE') && !defined('IN_ENANO_UPGRADE_POST') ) ) )
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    80
    {
616
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
    81
      // special case for the Enano installer: it will load its own strings from a JSON file and just use this API for fetching
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
    82
      // and templatizing them.
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
    83
      // 1.1.4 fix: this was still being called after main API startup from installer payload
243
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
    84
      $this->lang_id   = 1;
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
    85
      $this->lang_code = $lang;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    86
      return true;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    87
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    88
    if ( is_string($lang) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    89
    {
371
dc6026376919 Improved compatibility with PostgreSQL and fixed a number of installer bugs; fixed missing "meta" category declaration in language files
Dan
parents: 355
diff changeset
    90
      $sql_col = 'lang_code=\'' . $db->escape($lang) . '\'';
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    91
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    92
    else if ( is_int($lang) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    93
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    94
      $sql_col = 'lang_id=' . $lang . '';
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    95
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    96
    else
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    97
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    98
      $db->_die('lang.php - attempting to pass invalid value to constructor');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
    99
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   100
    
616
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
   101
    $lang_default = ( $x = getConfig('default_language') ) ? intval($x) : '0';
372
5bd429428101 A number of scattered changes. Profiler added and only enabled in debug mode (currently on), but awfully useful for fixing performance in the future. Started work on Admin:LangManager
Dan
parents: 371
diff changeset
   102
    
5bd429428101 A number of scattered changes. Profiler added and only enabled in debug mode (currently on), but awfully useful for fixing performance in the future. Started work on Admin:LangManager
Dan
parents: 371
diff changeset
   103
    $q = $db->sql_query("SELECT lang_id, lang_code, last_changed, ( lang_id = $lang_default ) AS is_default FROM " . table_prefix . "language WHERE $sql_col OR lang_id = $lang_default ORDER BY is_default ASC LIMIT 1;");
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   104
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   105
    if ( !$q )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   106
      $db->_die('lang.php - main select query');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   107
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   108
    if ( $db->numrows() < 1 )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   109
      $db->_die('lang.php - There are no languages installed');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   110
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   111
    $row = $db->fetchrow();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   112
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   113
    $this->lang_id   = intval( $row['lang_id'] );
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   114
    $this->lang_code = $row['lang_code'];
210
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
   115
    $this->lang_timestamp = $row['last_changed'];
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   116
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   117
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   118
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   119
   * Fetches language strings from the database, or a cache file if it's available.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   120
   * @param bool If true (default), allows the cache to be used.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   121
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   122
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   123
  function fetch($allow_cache = true)
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   124
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   125
    global $db, $session, $paths, $template, $plugins; // Common objects
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   126
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   127
    // Attempt to load the strings from a cache file
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   128
    $loaded = false;
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   129
    
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   130
    if ( $allow_cache )
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   131
    {
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   132
      // Load the cache manager
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   133
      global $cache;
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   134
      
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   135
      if ( $cached = $cache->fetch("lang_{$this->lang_id}") )
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   136
      {
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   137
        $this->merge($cached);
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   138
        $loaded = true;
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   139
      }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   140
    }
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   141
    if ( !$loaded )
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   142
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   143
      // No cache file - select and retrieve from the database
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   144
      $q = $db->sql_unbuffered_query("SELECT string_category, string_name, string_content FROM " . table_prefix . "language_strings WHERE lang_id = {$this->lang_id};");
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   145
      if ( !$q )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   146
        $db->_die('lang.php - selecting language string data');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   147
      if ( $row = $db->fetchrow() )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   148
      {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   149
        $strings = array();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   150
        do
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   151
        {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   152
          $cat =& $row['string_category'];
371
dc6026376919 Improved compatibility with PostgreSQL and fixed a number of installer bugs; fixed missing "meta" category declaration in language files
Dan
parents: 355
diff changeset
   153
          if ( !is_array(@$strings[$cat]) )
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   154
          {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   155
            $strings[$cat] = array();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   156
          }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   157
          $strings[$cat][ $row['string_name'] ] = $row['string_content'];
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   158
        }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   159
        while ( $row = $db->fetchrow() );
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   160
        // all done fetching
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   161
        $this->merge($strings);
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   162
        $this->regen_caches(false);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   163
      }
654
18dbf386d356 Made lang.php stop dying due to no strings installed for current language [experimental]
Dan
parents: 626
diff changeset
   164
      /*
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   165
      else
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   166
      {
241
c671f3bb8aed Trying to get lang import to work in the installer; it's not working ATM - cache file is generated with lang_id = 0. Syncing to Nighthawk.
Dan
parents: 239
diff changeset
   167
        if ( !defined('ENANO_ALLOW_LOAD_NOLANG') )
c671f3bb8aed Trying to get lang import to work in the installer; it's not working ATM - cache file is generated with lang_id = 0. Syncing to Nighthawk.
Dan
parents: 239
diff changeset
   168
          $db->_die('lang.php - No strings for language ' . $this->lang_code);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   169
      }
654
18dbf386d356 Made lang.php stop dying due to no strings installed for current language [experimental]
Dan
parents: 626
diff changeset
   170
      */
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   171
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   172
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   173
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   174
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   175
   * Loads a file from the disk cache (treated as PHP) and merges it into RAM.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   176
   * @param string File to load
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   177
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   178
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   179
  function load_cache_file($file)
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   180
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   181
    global $db, $session, $paths, $template, $plugins; // Common objects
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   182
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   183
    if ( !file_exists($file) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   184
      $db->_die('lang.php - requested cache file doesn\'t exist');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   185
    
590
03a60844c7c5 Several optimization changes including getting rid of a few eval()s. Added placeholder functions for the theme manager, which should be working now
Dan
parents: 555
diff changeset
   186
    @include($file);
03a60844c7c5 Several optimization changes including getting rid of a few eval()s. Added placeholder functions for the theme manager, which should be working now
Dan
parents: 555
diff changeset
   187
        
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   188
    if ( !isset($lang_cache) || ( isset($lang_cache) && !is_array($lang_cache) ) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   189
      $db->_die('lang.php - the cache file is invalid (didn\'t set $lang_cache as an array)');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   190
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   191
    $this->merge($lang_cache);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   192
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   193
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   194
  /**
243
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   195
   * Loads a JSON language file and parses the strings into RAM. Will use the cache if possible, but stays far away from the database,
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   196
   * which we assume doesn't exist yet.
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   197
   */
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   198
  
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   199
  function load_file($file)
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   200
  {
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   201
    global $db, $session, $paths, $template, $plugins; // Common objects
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   202
    
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   203
    if ( !file_exists($file) )
348
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   204
    {
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   205
      if ( defined('IN_ENANO_INSTALL') )
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   206
      {
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   207
        die('lang.php - requested JSON file (' . htmlspecialchars($file) . ') doesn\'t exist');
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   208
      }
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   209
      else
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   210
      {
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   211
        $db->_die('lang.php - requested JSON file doesn\'t exist');
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   212
      }
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   213
    }
243
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   214
    
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   215
    $contents = trim(@file_get_contents($file));
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   216
    if ( empty($contents) )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   217
      $db->_die('lang.php - empty language file...');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   218
    
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   219
    // Trim off all text before and after the starting and ending braces
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   220
    $contents = preg_replace('/^([^{]+)\{/', '{', $contents);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   221
    $contents = preg_replace('/\}([^}]+)$/', '}', $contents);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   222
    $contents = trim($contents);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   223
    
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   224
    if ( empty($contents) )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   225
      $db->_die('lang.php - no meat to the language file...');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   226
    
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   227
    $checksum = md5($contents);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   228
    if ( file_exists("./cache/lang_json_{$checksum}.php") )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   229
    {
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   230
      $this->load_cache_file("./cache/lang_json_{$checksum}.php");
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   231
    }
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   232
    else
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   233
    {
348
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   234
      // Correct syntax to be nice to the json parser
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   235
    
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   236
      // eliminate comments
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   237
      $contents = preg_replace(array(
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   238
              // eliminate single line comments in '// ...' form
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   239
              '#^\s*//(.+)$#m',
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   240
              // eliminate multi-line comments in '/* ... */' form, at start of string
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   241
              '#^\s*/\*(.+)\*/#Us',
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   242
              // eliminate multi-line comments in '/* ... */' form, at end of string
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   243
              '#/\*(.+)\*/\s*$#Us'
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   244
            ), '', $contents);
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   245
      
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   246
      $contents = preg_replace('/([,\{\[])([\s]*?)([a-z0-9_]+)([\s]*?):/', '\\1\\2"\\3" :', $contents);
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   247
      
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   248
      try
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   249
      {
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   250
        $langdata = enano_json_decode($contents);
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   251
      }
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   252
      catch(Zend_Json_Exception $e)
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   253
      {
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   254
        $db->_die('lang.php - Exception caught by JSON parser</p><pre>' . htmlspecialchars(print_r($e, true)) . '</pre><p>');
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   255
        exit;
87e08a6e4fec Welcome to the new Enano installer. Much distance still to be covered but the basics are there.
Dan
parents: 345
diff changeset
   256
      }
243
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   257
    
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   258
      if ( !is_array($langdata) )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   259
        $db->_die('lang.php - invalid language file');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   260
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   261
      if ( !isset($langdata['categories']) || !isset($langdata['strings']) )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   262
        $db->_die('lang.php - language file does not contain the proper items');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   263
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   264
      $this->merge($langdata['strings']);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   265
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   266
      $lang_file = "./cache/lang_json_{$checksum}.php";
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   267
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   268
      $handle = @fopen($lang_file, 'w');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   269
      if ( !$handle )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   270
        // Couldn't open the file. Silently fail and let the strings come from RAM.
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   271
        return false;
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   272
        
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   273
      // The file's open, that means we should be good.
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   274
      fwrite($handle, '<?php
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   275
// This file was generated automatically by Enano. You should not edit this file because any changes you make
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   276
// to it will not be visible in the ACP and all changes will be lost upon any changes to strings in the admin panel.
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   277
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   278
$lang_cache = ');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   279
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   280
      $exported = $this->var_export_string($this->strings);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   281
      if ( empty($exported) )
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   282
        // Ehh, that's not good
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   283
        $db->_die('lang.php - load_file(): var_export_string() failed');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   284
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   285
      fwrite($handle, $exported . '; ?>');
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   286
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   287
      // Clean up
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   288
      unset($exported, $langdata);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   289
      
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   290
      // Done =)
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   291
      fclose($handle);
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   292
    }
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   293
  }
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   294
  
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   295
  /**
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   296
   * Merges a standard language assoc array ($arr[cat][stringid]) with the master in RAM.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   297
   * @param array
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   298
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   299
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   300
  function merge($strings)
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   301
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   302
    // This is stupidly simple.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   303
    foreach ( $strings as $cat_id => $contents )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   304
    {
243
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   305
      if ( !isset($this->strings[$cat_id]) || ( isset($this->strings[$cat_id]) && !is_array($this->strings[$cat_id]) ) )
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   306
        $this->strings[$cat_id] = array();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   307
      foreach ( $contents as $string_id => $string )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   308
      {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   309
        $this->strings[$cat_id][$string_id] = $string;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   310
      }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   311
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   312
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   313
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   314
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   315
   * Imports a JSON-format language file into the database and merges with current strings.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   316
   * @param string Path to the JSON file to load
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   317
   * @param bool If true, only imports new strings and skips those that already exist. Defaults to false (import all strings)
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   318
   * @param bool Enable debugging output, makes the process over CLI more interesting
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   319
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   320
  
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   321
  function import($file, $skip_existing = false, $debug = false)
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   322
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   323
    global $db, $session, $paths, $template, $plugins; // Common objects
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   324
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   325
    if ( !file_exists($file) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   326
      $db->_die('lang.php - can\'t import language file: string file doesn\'t exist');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   327
    
241
c671f3bb8aed Trying to get lang import to work in the installer; it's not working ATM - cache file is generated with lang_id = 0. Syncing to Nighthawk.
Dan
parents: 239
diff changeset
   328
    if ( $this->lang_id == 0 )
c671f3bb8aed Trying to get lang import to work in the installer; it's not working ATM - cache file is generated with lang_id = 0. Syncing to Nighthawk.
Dan
parents: 239
diff changeset
   329
      $db->_die('lang.php - BUG: trying to perform import when $lang->lang_id == 0');
c671f3bb8aed Trying to get lang import to work in the installer; it's not working ATM - cache file is generated with lang_id = 0. Syncing to Nighthawk.
Dan
parents: 239
diff changeset
   330
    
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   331
    if ( $debug )
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   332
      $br = ( isset($_SERVER['REQUEST_URI']) ) ? '<br />' : '';
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   333
    
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   334
    if ( $debug )
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   335
      echo "Importing file: $file$br\n  Checking file...$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   336
    
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   337
    $contents = trim(@file_get_contents($file));
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   338
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   339
    if ( empty($contents) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   340
      $db->_die('lang.php - can\'t load the contents of the language file');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   341
    
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   342
    if ( $debug )
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   343
      echo "  Cleaning up JSON$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   344
    
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   345
    // Trim off all text before and after the starting and ending braces
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   346
    $contents = preg_replace('/^([^{]+)\{/', '{', $contents);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   347
    $contents = preg_replace('/\}([^}]+)$/', '}', $contents);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   348
    
334
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   349
    // Correct syntax to be nice to the json parser
372
5bd429428101 A number of scattered changes. Profiler added and only enabled in debug mode (currently on), but awfully useful for fixing performance in the future. Started work on Admin:LangManager
Dan
parents: 371
diff changeset
   350
    $contents = enano_clean_json($contents);
334
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   351
    
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   352
    if ( $debug )
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   353
      echo "  Decoding JSON stream$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   354
    
334
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   355
    try
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   356
    {
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   357
      $langdata = enano_json_decode($contents);
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   358
    }
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   359
    catch(Zend_Json_Exception $e)
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   360
    {
335
67bd3121a12e Replaced TinyMCE 2.x with 3.0 beta 3. Supports everything but IE. Also rewrote the editor interface completely from the ground up.
Dan
parents: 334
diff changeset
   361
      $db->_die('lang.php - Exception caught by JSON parser</p><pre>' . htmlspecialchars(print_r($e, true)) . '</pre><p>');
334
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   362
      exit;
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   363
    }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   364
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   365
    if ( !is_array($langdata) )
334
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   366
    {
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   367
      $db->_die('lang.php - invalid or non-well-formed language file');
c72b545f1304 More localization work. Resolved major issue with JSON parser not parsing files over ~50KB. Switched JSON parser to the one from the Zend Framework (BSD licensed). Forced to split enano.json into five different files.
Dan
parents: 243
diff changeset
   368
    }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   369
    
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   370
    if ( $debug )
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   371
      echo "  Starting string import$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   372
    
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   373
    return $this->import_array($langdata, $skip_existing, $debug);
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   374
  }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   375
  
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   376
  /**
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   377
   * Imports a JSON-format language file into the database and merges with current strings.
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   378
   * @param string Path to plugin file
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   379
   */
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   380
  
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   381
  function import_plugin($file)
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   382
  {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   383
    global $db, $session, $paths, $template, $plugins; // Common objects
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   384
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   385
    if ( !file_exists($file) )
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   386
      $db->_die('lang.php - can\'t import language file: string file doesn\'t exist');
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   387
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   388
    if ( $this->lang_id == 0 )
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   389
      $db->_die('lang.php - BUG: trying to perform import when $lang->lang_id == 0');
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   390
    
507
586fd7d3202d Fixed some stray version numbers (again!); added support for Diffie-Hellman logins in the normal login form (not AJAX) - even works in IE
Dan
parents: 504
diff changeset
   391
    $block = pluginLoader::parse_plugin_blocks($file, 'language');
586fd7d3202d Fixed some stray version numbers (again!); added support for Diffie-Hellman logins in the normal login form (not AJAX) - even works in IE
Dan
parents: 504
diff changeset
   392
    if ( !is_array($block) )
586fd7d3202d Fixed some stray version numbers (again!); added support for Diffie-Hellman logins in the normal login form (not AJAX) - even works in IE
Dan
parents: 504
diff changeset
   393
      return false;
586fd7d3202d Fixed some stray version numbers (again!); added support for Diffie-Hellman logins in the normal login form (not AJAX) - even works in IE
Dan
parents: 504
diff changeset
   394
    if ( !isset($block[0]) )
586fd7d3202d Fixed some stray version numbers (again!); added support for Diffie-Hellman logins in the normal login form (not AJAX) - even works in IE
Dan
parents: 504
diff changeset
   395
      return false;
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   396
    
507
586fd7d3202d Fixed some stray version numbers (again!); added support for Diffie-Hellman logins in the normal login form (not AJAX) - even works in IE
Dan
parents: 504
diff changeset
   397
    $contents =& $block[0]['value'];
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   398
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   399
    // Trim off all text before and after the starting and ending braces
519
94214ec0871c Started work on the new plugin manager and associated management code. Very incomplete at this point and not usable.
Dan
parents: 516
diff changeset
   400
    $contents = enano_trim_json($contents);
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   401
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   402
    // Correct syntax to be nice to the json parser
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   403
    $contents = enano_clean_json($contents);
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   404
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   405
    try
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   406
    {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   407
      $langdata = enano_json_decode($contents);
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   408
    }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   409
    catch(Zend_Json_Exception $e)
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   410
    {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   411
      $db->_die('lang.php - Exception caught by JSON parser</p><pre>' . htmlspecialchars(print_r($e, true)) . '</pre><p>');
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   412
      exit;
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   413
    }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   414
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   415
    if ( !is_array($langdata) )
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   416
    {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   417
      $db->_die('lang.php - invalid or non-well-formed language file');
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   418
    }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   419
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   420
    // Does the plugin support the current language?
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   421
    if ( isset($langdata[$this->lang_code]) )
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   422
    {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   423
      // Yes, import that
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   424
      return $this->import_array($langdata[$this->lang_code]);
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   425
    }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   426
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   427
    // Just import the first language we run across.
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   428
    $supported_langs = array_keys($langdata);
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   429
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   430
    if ( !isset($supported_langs[0]) )
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   431
    {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   432
      $db->_die('lang.php - plugin has an invalid or corrupt language block');
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   433
    }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   434
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   435
    $first_lang = $supported_langs[0];
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   436
    
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   437
    return $this->import_array($langdata[$first_lang]);
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   438
  }
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   439
  
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   440
  /**
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   441
   * Performs the actual import of string data.
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   442
   * @param array Parsed JSON object, should be in the form of an array
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   443
   * @param bool If true, only imports new strings and skips those that already exist. Defaults to false.
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   444
   * @param bool Enable debugging output
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   445
   * @access private
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   446
   */
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   447
  
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   448
  protected function import_array($langdata, $skip_existing = false, $debug = false) 
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   449
  {
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   450
    global $db, $session, $paths, $template, $plugins; // Common objects
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   451
    
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   452
    if ( !isset($langdata['categories']) || !isset($langdata['strings']) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   453
      $db->_die('lang.php - language file does not contain the proper items');
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   454
    
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   455
    if ( $debug )
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   456
      $br = ( isset($_SERVER['REQUEST_URI']) ) ? '<br />' : '';
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   457
    
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   458
    $insert_list = array();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   459
    $delete_list = array();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   460
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   461
    foreach ( $langdata['categories'] as $category )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   462
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   463
      if ( isset($langdata['strings'][$category]) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   464
      {
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   465
        if ( $debug )
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   466
        {
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   467
          $desc = ( isset($langdata['strings']['meta'][$category]) ) ? $langdata['strings']['meta'][$category] : $this->get("meta_$category");
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   468
          echo "  Indexing category: $category ({$desc})$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   469
        }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   470
        foreach ( $langdata['strings'][$category] as $string_name => $string_value )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   471
        {
626
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   472
          // should we skip this string?
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   473
          if ( isset($this->strings[$category]) && $skip_existing )
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   474
          {
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   475
            if ( isset($this->strings[$category][$string_name]) )
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   476
            {
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   477
              // already exists, skip
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   478
              if ( $debug )
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   479
                echo "    Skipping string (already exists): {$category}_{$string_name}$br\n";
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   480
              continue;
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   481
            }
be0e904eec17 Refined upgrade process a bit. Uses libenanoinstall (incomplete), and post stage added to flush caches and import new strings
Dan
parents: 623
diff changeset
   482
          }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   483
          $string_name = $db->escape($string_name);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   484
          $string_value = $db->escape($string_value);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   485
          $category_name = $db->escape($category);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   486
          $insert_list[] = "({$this->lang_id}, '$category_name', '$string_name', '$string_value')";
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   487
          $delete_list[] = "( lang_id = {$this->lang_id} AND string_category = '$category_name' AND string_name = '$string_name' )";
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   488
        }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   489
      }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   490
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   491
    
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   492
    if ( $debug )
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   493
    {
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   494
      echo "  Running deletion of old strings...";
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   495
      $start = microtime_float();
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   496
    }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   497
    $delete_list = implode(" OR\n  ", $delete_list);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   498
    
377
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   499
    if ( !empty($delete_list) )
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   500
    {
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   501
      $sql = "DELETE FROM " . table_prefix . "language_strings WHERE $delete_list;";
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   502
      
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   503
      // Free some memory
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   504
      unset($delete_list);
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   505
      
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   506
      // Run the query
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   507
      $q = $db->sql_query($sql);
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   508
      if ( !$q )
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   509
        $db->_die('lang.php - couldn\'t kill off them old strings');
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   510
    }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   511
    
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   512
    if ( $debug )
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   513
    {
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   514
      $time = round(microtime_float() - $start, 5);
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   515
      echo "({$time}s)$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   516
    }
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   517
    
377
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   518
    if ( !empty($insert_list) )
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   519
    {
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   520
      if ( $debug )
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   521
      {
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   522
        echo "  Inserting strings...";
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   523
        $start = microtime_float();
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   524
      }
377
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   525
      $insert_list = implode(",\n  ", $insert_list);
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   526
      $sql = "INSERT INTO " . table_prefix . "language_strings(lang_id, string_category, string_name, string_content) VALUES\n  $insert_list;";
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   527
      
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   528
      // Free some memory
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   529
      unset($insert_list);
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   530
      
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   531
      // Run the query
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   532
      $q = $db->sql_query($sql);
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   533
      if ( !$q )
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   534
        $db->_die('lang.php - couldn\'t insert strings in import()');
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   535
      
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   536
      if ( $debug )
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   537
      {
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   538
        $time = round(microtime_float() - $start, 5);
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   539
        echo "({$time}s)$br\n";
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   540
      }
377
bb3e6c3bd4f4 Removed stray debugging info from ACL editor success notification; added ability for guests to set language on URI (?lang=eng); added html_in_pages ACL type and separated from php_in_pages so HTML can be embedded but not PHP; rewote portions of the path manager to better abstract URL input; added Zend Framework into list of BSD-licensed libraries; localized some remaining strings; got the migration script working, but just barely; fixed display bug in Special:Contributions; localized Main Page button in admin panel
Dan
parents: 376
diff changeset
   541
    }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   542
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   543
    // YAY! done!
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   544
    // This will regenerate the cache file if possible.
514
ecbfb747743e Added debugging switch to $lang->import() for help with optimization
Dan
parents: 507
diff changeset
   545
    if ( $debug )
516
9a52679143db Added debugging ability to Language::import() for CLI usage
Dan
parents: 514
diff changeset
   546
      echo "  Regenerating cache file$br\n";
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   547
    $this->regen_caches();
555
ac4c6a7f01d8 Added user preference for disabling visual effects in Javascript applets; added re-import button to installed plugins
Dan
parents: 536
diff changeset
   548
    
ac4c6a7f01d8 Added user preference for disabling visual effects in Javascript applets; added re-import button to installed plugins
Dan
parents: 536
diff changeset
   549
    return true;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   550
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   551
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   552
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   553
   * Refetches the strings and writes out the cache file.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   554
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   555
  
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   556
  function regen_caches($refetch = true)
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   557
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   558
    global $db, $session, $paths, $template, $plugins; // Common objects
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   559
    
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   560
    // Refresh the strings in RAM to the latest copies in the DB
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   561
    if ( $refetch )
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   562
      $this->fetch(false);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   563
    
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   564
    // Load the cache manager
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   565
    global $cache;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   566
    
607
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   567
    // Store it
935f3799b654 First stab at cache management backend. Everything seems to have been tested and working so far, but a number of things require a more specialized cache and can't go through the framework (e.g. user ranks which use references to map usernames to user IDs)
Dan
parents: 593
diff changeset
   568
    $cache->store("lang_{$this->lang_id}", $this->strings, -1);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   569
    
210
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
   570
    // Update timestamp in database
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
   571
    $q = $db->sql_query('UPDATE ' . table_prefix . 'language SET last_changed = ' . time() . ' WHERE lang_id = ' . $this->lang_id . ';');
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
   572
    if ( !$q )
2b283402e4e4 Added language export to JSON page and localization for Javascript using $lang.get(). Localized AJAX login interface.
Dan
parents: 209
diff changeset
   573
      $db->_die('lang.php - updating timestamp on language');
613
c08670a77871 Completed work (we hope) on CacheManager admin page
Dan
parents: 607
diff changeset
   574
    
c08670a77871 Completed work (we hope) on CacheManager admin page
Dan
parents: 607
diff changeset
   575
    return true;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   576
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   577
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   578
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   579
   * Calls var_export() on whatever, and returns the function's output.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   580
   * @param mixed Whatever you want var_exported. Usually an array.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   581
   * @return string
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   582
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   583
  
590
03a60844c7c5 Several optimization changes including getting rid of a few eval()s. Added placeholder functions for the theme manager, which should be working now
Dan
parents: 555
diff changeset
   584
  static function var_export_string($val)
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   585
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   586
    ob_start();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   587
    var_export($val);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   588
    $contents = ob_get_contents();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   589
    ob_end_clean();
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   590
    return $contents;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   591
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   592
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   593
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   594
   * Fetches a language string from the cache in RAM. If it isn't there, it will call fetch() again and then try. If it still can't find it, it will ask for the string
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   595
   * in the default language. If even then the string can't be found, this function will return what was passed to it.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   596
   *
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   597
   * This will also templatize strings. If a string contains variables in the format %foo%, you may specify the second parameter as an associative array in the format
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   598
   * of 'foo' => 'foo substitute'.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   599
   *
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   600
   * @param string ID of the string to fetch. This will always be in the format of category_stringid.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   601
   * @param array Optional. Associative array of substitutions.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   602
   * @return string
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   603
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   604
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   605
  function get($string_id, $substitutions = false)
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   606
  {
376
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   607
    if ( !is_array($substitutions) )
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   608
      $substitutions = array();
536
218a627eb53e Rebrand as 1.1.4 (Caoineag alpha 4)
Dan
parents: 519
diff changeset
   609
    // if this isn't a valid language string ID, just return the string unprocessed.
218a627eb53e Rebrand as 1.1.4 (Caoineag alpha 4)
Dan
parents: 519
diff changeset
   610
    if ( !preg_match('/^([a-z0-9]+)((_[a-z0-9]+)+)$/', $string_id) )
218a627eb53e Rebrand as 1.1.4 (Caoineag alpha 4)
Dan
parents: 519
diff changeset
   611
      return $string_id;
376
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   612
    return $this->substitute($this->get_uncensored($string_id), $substitutions);
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   613
  }
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   614
  
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   615
  /**
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   616
   * The same as get(), but does not perform any substitution or filtering. Used in get() (of course) and in the admin panel, where
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   617
   * strings are updated only if they were changed.
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   618
   *
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   619
   * @param string ID of the string to fetch. This will always be in the format of category_stringid.
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   620
   * @param array Optional. Associative array of substitutions.
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   621
   * @return string
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   622
   */
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   623
  
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   624
  function get_uncensored($string_id, $substitutions = false)
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   625
  {
616
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
   626
    global $db, $session, $paths, $template, $plugins; // Common objects
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
   627
    
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   628
    // Extract the category and string ID
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   629
    $category = substr($string_id, 0, ( strpos($string_id, '_') ));
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   630
    $string_name = substr($string_id, ( strpos($string_id, '_') + 1 ));
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   631
    $found = false;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   632
    if ( isset($this->strings[$category]) && isset($this->strings[$category][$string_name]) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   633
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   634
      $found = true;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   635
      $string = $this->strings[$category][$string_name];
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   636
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   637
    if ( !$found )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   638
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   639
      // Ehh, the string wasn't found. Rerun fetch() and try again.
536
218a627eb53e Rebrand as 1.1.4 (Caoineag alpha 4)
Dan
parents: 519
diff changeset
   640
      // Or if it's the installer, no use in refetching, so just fail.
616
e311f5e6f904 Got the installer working. Fixed a few bugs including a nasty-to-debug issue where the lang_id was being hardcoded during installation, resulting in strings being inserted with the wrong lang_id causing an infinfinite loop with fetch() throwing a "no strings" error and using template (which calls fetch()) to complain
Dan
parents: 613
diff changeset
   641
      if ( defined('IN_ENANO_INSTALL') || ( defined('ENANO_INSTALLED') && !@$db->_conn ) )
243
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   642
      {
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   643
        return $string_id;
a7d0f2711df1 Installer localization started. Welcome, License, and SysReqs pages are fully localized.
Dan
parents: 241
diff changeset
   644
      }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   645
      $this->fetch();
593
4f9bec0d65c1 More optimization work. Moved special page init functions to common instead of common_post hook. Allowed paths to cache page metadata on filesystem. Phased out the redundancy in $paths->pages that paired a number with every urlname as foreach loops are allowed now (and have been for some time). Fixed missing includes for several functions. Rewrote str_replace_once to be a lot more efficient.
Dan
parents: 590
diff changeset
   646
      profiler_log('Language(' . $this->lang_code . '): refetched due to missing string: ' . $string_id);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   647
      if ( isset($this->strings[$category]) && isset($this->strings[$category][$string_name]) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   648
      {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   649
        $found = true;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   650
        $string = $this->strings[$category][$string_name];
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   651
      }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   652
      if ( !$found )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   653
      {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   654
        // STILL not found. Check the default language.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   655
        $lang_default = ( $x = getConfig('default_language') ) ? intval($x) : $this->lang_id;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   656
        if ( $lang_default != $this->lang_id )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   657
        {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   658
          if ( !is_object($this->default) )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   659
            $this->default = new Language($lang_default);
376
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   660
          return $this->default->get_uncensored($string_id);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   661
        }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   662
      }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   663
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   664
    if ( !$found )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   665
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   666
      // Alright, it's nowhere. Return the input, grumble grumble...
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   667
      return $string_id;
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   668
    }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   669
    // Found it!
376
66732bd4532c Finished (or nearly finished) the admin language CP
Dan
parents: 372
diff changeset
   670
    return $string;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   671
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   672
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   673
  /**
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   674
   * Processes substitutions.
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   675
   * @param string
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   676
   * @param array
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   677
   * @return string
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   678
   */
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   679
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   680
  function substitute($string, $subs)
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   681
  {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   682
    preg_match_all('/%this\.([a-z0-9_]+)%/', $string, $matches);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   683
    if ( count($matches[0]) > 0 )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   684
    {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   685
      foreach ( $matches[1] as $i => $string_id )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   686
      {
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   687
        $result = $this->get($string_id);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   688
        $string = str_replace($matches[0][$i], $result, $string);
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   689
      }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   690
    }
209
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   691
    preg_match_all('/%config\.([a-z0-9_]+)%/', $string, $matches);
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   692
    if ( count($matches[0]) > 0 )
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   693
    {
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   694
      foreach ( $matches[1] as $i => $string_id )
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   695
      {
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   696
        $result = getConfig($string_id);
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   697
        $string = str_replace($matches[0][$i], $result, $string);
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   698
      }
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   699
    }
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   700
    foreach ( $subs as $key => $value )
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   701
    {
209
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   702
      $subs[$key] = strval($value);
8a00247d1dee Login page mostly localized
Dan
parents: 205
diff changeset
   703
      $string = str_replace("%{$key}%", "{$subs[$key]}", $string);
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   704
    }
504
bc8e0e9ee01d Added support for embedding language data into plugins; updated all version numbers on plugin files
Dan
parents: 391
diff changeset
   705
    return ( $this->debug ) ? "$string*" : $string;
205
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   706
  }
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   707
  
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   708
} // class Language
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   709
c4542792db2b Localization low-level framework added
Dan
parents:
diff changeset
   710
?>