aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/DbSnapshot.php
blob: 33ea6600a388b95ec94cf5575e0cf7a2dde2f54f (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<?php
# Lifter002: TODO
# Lifter007: TODO
# Lifter003: TODO
# Lifter010: TODO
// +---------------------------------------------------------------------------+
// This file is part of Stud.IP
// DbSnapshot.php
// Class to provide snapshots of mysql result sets
// Uses PHPLib DB Abstraction
// Copyright (c) 2002 André Noack <andre.noack@gmx.net>
// +---------------------------------------------------------------------------+
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or 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 General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
// +---------------------------------------------------------------------------+


/**
 * Class to provide snapshots of mysql result sets
 *
 * Uses DB abstraction layer of PHPLib
 *
 * @access   public
 * @author   André Noack <andre.noack@gmx.net>
 * @package  DBTools
 **/
class DbSnapshot
{

    /**
     * the used db abstraction class
     *
     *
     * @access   private
     * @var      string $DbClass
     */
    var $DbClass = "DB_Sql";
    /**
     * the used db result set
     *
     *
     * @access   private
     * @var      object DB_Sql   $dbResult
     */
    var $dbResult = null;
    /**
     * array to store the result set
     *
     *
     * @access   private
     * @var      array $result
     */
    var $result = [];
    /**
     * array to store metadata oh the result set
     *
     *
     * @access   private
     * @var      array $metaData
     */
    var $metaData = [];
    /**
     * the number of fields in the result set
     *
     *
     * @access   public
     * @var      integer $numFields
     */
    var $numFields = 0;
    /**
     * the number of rows in the result set
     *
     *
     * @access   public
     * @var      integer $numRows
     */
    var $numRows = 0;
    /**
     * the internal row pointer
     *
     *
     * @access   private
     * @var      mixed $pos
     */
    var $pos = false;
    /**
     * turn on/off debugging
     *
     *
     * @access   public
     * @var      boolean $debug
     */
    var $debug = false;

    /**
     * Constructor
     *
     * Pass instance of DbClass or nothing to specify result set later
     *
     * @access   public
     *
     * @param    object DB_Sql   $dbresult
     */
    public function __construct($dbresult = null)
    {
        if (is_object($dbresult)) {
            $this->dbResult = $dbresult;
            $this->getSnapshot();
        }

    }

    function isDbResult()
    {
        if (!is_subclass_of($this->dbResult, $this->DbClass))
            $this->halt("Result set has wrong type!");
        if (!$this->dbResult->query_id())
            $this->halt("No result set (missing query?)");

        return true;
    }

    public function getSnapshot()
    {
        if ($this->isDbResult()) {
            $this->numFields = $this->dbResult->num_fields();
            $this->numRows   = $this->dbResult->num_rows();
            $this->metaData  = $this->dbResult->metadata();
            $this->result    = [];
            while ($this->dbResult->next_record()) {
                $this->result[] = $this->dbResult->Record;
            }
            unset($this->dbResult);
            $this->pos = false;

            return true;
        }

        return false;
    }

    public function nextRow()
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");
        if ($this->pos === false) {
            $this->pos = 0;

            return true;
        }
        if (++$this->pos < $this->numRows)
            return true;
        else
            return false;
    }

    public function resetPos()
    {
        $this->pos = false;
    }

    public function isField($name)
    {
        for ($i = 0; $i < $this->numFields; ++$i) {
            if ($name == $this->metaData[$i]['name']) {
                return true;
            }
        }

        return false;
    }

    public function getRow($row = false)
    {
        if (!$row === false AND !$this->result[$row])
            $this->halt("Snapshot has only " . ($this->numRows - 1) . " rows!");

        return ($row === false) ? $this->result[$this->pos] : $this->result[$row];
    }

    public function getFieldList()
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");
        $ret = [];
        for ($i = 0; $i < $this->numFields; ++$i) {
            $ret[] = $this->metaData[$i]['name'];
        }

        return $ret;
    }

    public function getField($field = 0)
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");

        return ($this->pos === false) ? false : $this->result[$this->pos][$field];
    }

    public function getRows($fieldname = 0)
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");
        $ret = [];
        for ($i = 0; $i < $this->numRows; ++$i) {
            $ret[] = $this->result[$i][$fieldname];
        }

        return $ret;
    }

    public function getDistinctRows($fieldname)
    {
        if (!$this->isField($fieldname))
            $this->halt("Field: $fieldname not found in result set!");
        $ret = [];
        for ($i = 0; $i < $this->numRows; ++$i) {
            $ret[$this->result[$i][$fieldname]]        = $this->result[$i];
            $ret[$this->result[$i][$fieldname]]['row'] = $i;
        }

        return $ret;
    }

    public function sortRows($fieldname = 0, $order = "ASC", $stype = false)
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");
        $sortfields = $this->getRows($fieldname);
        if ($stype !== false) {
            $sortfunc = ($order == "ASC") ? "asort" : "arsort";
            $sortfunc($sortfields, $stype);
        } else {
            uasort($sortfields, function ($a,$b) {
                $a = mb_strtolower($a);
                $a = str_replace('ä', 'ae', $a);
                $a = str_replace('ö', 'oe', $a);
                $a = str_replace('ü', 'ue', $a);

                $b = mb_strtolower($b);
                $b = str_replace('ä', 'ae', $b);
                $b = str_replace('ö', 'oe', $b);
                $b = str_replace('ü', 'ue', $b);

                return strnatcasecmp($a, $b);
            });
            if ($order == "DESC") {
                $sortfields = array_reverse($sortfields, true);
            }
        }
        $sortresult = [];
        foreach ($sortfields as $key => $value) {
            $sortresult[] = $this->result[$key];
        }
        $this->result = $sortresult;
        $this->resetPos();

        return true;
    }

    public function searchFields($fieldname, $searchstr)
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");
        $ret        = false;
        $sortfields = $this->getRows($fieldname);
        foreach ($sortfields as $key => $value) {
            if (preg_match($searchstr, $value)) {
                $ret       = true;
                $this->pos = $key;
                break;
            }
        }

        return $ret;
    }

    public function getGroupedResult($group_by_field, $fields_to_group = null)
    {
        if (!$this->numRows)
            $this->halt("No snapshot available or empty result!");
        $fieldlist = $this->getFieldList();
        if (!in_array($group_by_field, $fieldlist))
            $this->halt("group_by_field not found in result set!");
        if (is_array($fields_to_group))
            $fieldlist = $fields_to_group;
        $num_fields = count($fieldlist);
        $ret        = [];
        for ($i = 0; $i < $this->numRows; ++$i) {
            for ($j = 0; $j < $num_fields; ++$j) {
                if ($fieldlist[$j] != $group_by_field) {
                    if (empty($ret[$this->result[$i][$group_by_field]][$fieldlist[$j]][$this->result[$i][$fieldlist[$j]]])) {
                        $ret[$this->result[$i][$group_by_field]][$fieldlist[$j]][$this->result[$i][$fieldlist[$j]]] = 0;
                    }
                    ++$ret[$this->result[$i][$group_by_field]][$fieldlist[$j]][$this->result[$i][$fieldlist[$j]]];
                }
            }
        }

        return $ret;
    }

    public function mergeSnapshot($m_snap, $key_field = false, $mode = "ADD")
    {
        if ($mode == "ADD") {
            for ($i = 0; $i < $m_snap->numRows; ++$i) {
                $this->result[] = $m_snap->result[$i];
            }
        } elseif ($mode == "AND") {
            if (!$this->numRows || !$m_snap->numRows) {
                $this->result = [];
            } elseif ($m_snap->numRows) {
                $m_result = $m_snap->getDistinctRows($key_field);
                for ($i = 0; $i < $this->numRows; ++$i) {
                    if (!($m_result[$this->result[$i][$key_field]] && $this->result[$i][$key_field])) {
                        unset($this->result[$i]);
                    }
                }
            }
        } elseif ($mode == "OR") {
            if (!$this->numRows) {
                $this->result = $m_snap->result;
            } elseif ($m_snap->numRows) {
                $result = $this->getDistinctRows($key_field);
                for ($i = 0; $i < $m_snap->numRows; ++$i) {
                    if (empty($result[$m_snap->result[$i][$key_field]])) {
                        $this->result[] = $m_snap->result[$i];
                    }
                }
            }
        }
        $this->result  = array_merge([], (array)$this->result);
        $this->numRows = count($this->result);
        $this->resetPos();

        return $this->numRows;
    }

    /**
     * print error message and exit script
     *
     * @access   private
     *
     * @param    string $msg the message to print
     */
    public function halt($msg)
    {
        echo "<hr>$msg<hr>";
        if ($this->debug) {
            echo "<pre>";
            print_r($this);
            echo "</pre>";
            die;
        }

    }
}

?>