summaryrefslogtreecommitdiff
path: root/lib/schema.php
blob: d3b30aeeb5182cf3dd5d53547253324914a60840 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Database schema utilities
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Database
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Class representing the database schema
 *
 * A class representing the database schema. Can be used to
 * manipulate the schema -- especially for plugins and upgrade
 * utilities.
 *
 * @category Database
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class Schema
{
    static $_single = null;
    protected $conn = null;

    protected function __construct()
    {
        // XXX: there should be an easier way to do this.
        $user = new User();
        $this->conn = $user->getDatabaseConnection();
        $user->free();
        unset($user);
    }

    static function get()
    {
        if (empty(self::$_single)) {
            self::$_single = new Schema();
        }
        return self::$_single;
    }

    public function getTableDef($name)
    {
        $res =& $this->conn->query('DESCRIBE ' . $name);

        if (PEAR::isError($res)) {
            throw new Exception($res->getMessage());
        }

        $td = new TableDef();

        $td->name    = $name;
        $td->columns = array();

        $row = array();

        while ($res->fetchInto($row, DB_FETCHMODE_ASSOC)) {

            $cd = new ColumnDef();

            $cd->name = $row['Field'];

            $packed = $row['Type'];

            if (preg_match('/^(\w+)\((\d+)\)$/', $packed, $match)) {
                $cd->type = $match[1];
                $cd->size = $match[2];
            } else {
                $cd->type = $packed;
            }

            $cd->nullable = ($row['Null'] == 'YES') ? true : false;
            $cd->key      = $row['Key'];
            $cd->default  = $row['Default'];
            $cd->extra    = $row['Extra'];

            $td->columns[] = $cd;
        }

        return $td;
    }

    public function getColumnDef($table, $column)
    {
    }

    public function getIndexDef($table, $index)
    {
    }

    public function createTable($name, $columns, $indices=null)
    {
    }

    public function dropTable($name)
    {
    }

    public function createIndex($name, $table, $columns)
    {
    }

    public function dropIndex($name, $table)
    {
    }

    public function addColumn($table, $columndef)
    {
    }

    public function modifyColumn($table, $column, $columndef)
    {
    }

    public function dropColumn($table, $column)
    {
    }

    public function ensureTable($name, $columns, $indices)
    {
        $def = $this->tableDef($name);
        if (empty($def)) {
            return $this->createTable($name, $columns, $indices);
        }
    }
}

class TableDef
{
    public $name;
    public $columns;
}

class ColumnDef
{
    public $name;
    public $type;
    public $size;
    public $nullable;
    public $key;
    public $default;
    public $extra;
}

class IndexDef
{
    public $name;
    public $table;
    public $columns;
}