source: spip-zone/_plugins_/getID3/trunk/getid3/extension.cache.dbm.php @ 71835

Last change on this file since 71835 was 71835, checked in by kent1@…, 6 years ago

Upgrade de la lib en 1.9.5

Voir le changelog : http://www.getid3.org/source/changelog.txt

File size: 5.8 KB
Line 
1<?php
2/////////////////////////////////////////////////////////////////
3/// getID3() by James Heinrich <info@getid3.org>               //
4//  available at http://getid3.sourceforge.net                 //
5//            or http://www.getid3.org                         //
6/////////////////////////////////////////////////////////////////
7//                                                             //
8// extension.cache.dbm.php - part of getID3()                  //
9// Please see readme.txt for more information                  //
10//                                                            ///
11/////////////////////////////////////////////////////////////////
12//                                                             //
13// This extension written by Allan Hansen <ahØartemis*dk>      //
14//                                                            ///
15/////////////////////////////////////////////////////////////////
16
17
18/**
19* This is a caching extension for getID3(). It works the exact same
20* way as the getID3 class, but return cached information very fast
21*
22* Example:
23*
24*    Normal getID3 usage (example):
25*
26*       require_once 'getid3/getid3.php';
27*       $getID3 = new getID3;
28*       $getID3->encoding = 'UTF-8';
29*       $info1 = $getID3->analyze('file1.flac');
30*       $info2 = $getID3->analyze('file2.wv');
31*
32*    getID3_cached usage:
33*
34*       require_once 'getid3/getid3.php';
35*       require_once 'getid3/getid3/extension.cache.dbm.php';
36*       $getID3 = new getID3_cached('db3', '/tmp/getid3_cache.dbm',
37*                                          '/tmp/getid3_cache.lock');
38*       $getID3->encoding = 'UTF-8';
39*       $info1 = $getID3->analyze('file1.flac');
40*       $info2 = $getID3->analyze('file2.wv');
41*
42*
43* Supported Cache Types
44*
45*   SQL Databases:          (use extension.cache.mysql)
46*
47*   cache_type          cache_options
48*   -------------------------------------------------------------------
49*   mysql               host, database, username, password
50*
51*
52*   DBM-Style Databases:    (this extension)
53*
54*   cache_type          cache_options
55*   -------------------------------------------------------------------
56*   gdbm                dbm_filename, lock_filename
57*   ndbm                dbm_filename, lock_filename
58*   db2                 dbm_filename, lock_filename
59*   db3                 dbm_filename, lock_filename
60*   db4                 dbm_filename, lock_filename  (PHP5 required)
61*
62*   PHP must have write access to both dbm_filename and lock_filename.
63*
64*
65* Recommended Cache Types
66*
67*   Infrequent updates, many reads      any DBM
68*   Frequent updates                    mysql
69*/
70
71
72class getID3_cached_dbm extends getID3
73{
74
75        // public: constructor - see top of this file for cache type and cache_options
76        public function getID3_cached_dbm($cache_type, $dbm_filename, $lock_filename) {
77
78                // Check for dba extension
79                if (!extension_loaded('dba')) {
80                        throw new Exception('PHP is not compiled with dba support, required to use DBM style cache.');
81                }
82
83                // Check for specific dba driver
84                if (!function_exists('dba_handlers') || !in_array($cache_type, dba_handlers())) {
85                        throw new Exception('PHP is not compiled --with '.$cache_type.' support, required to use DBM style cache.');
86                }
87
88                // Create lock file if needed
89                if (!file_exists($lock_filename)) {
90                        if (!touch($lock_filename)) {
91                                throw new Exception('failed to create lock file: '.$lock_filename);
92                        }
93                }
94
95                // Open lock file for writing
96                if (!is_writeable($lock_filename)) {
97                        throw new Exception('lock file: '.$lock_filename.' is not writable');
98                }
99                $this->lock = fopen($lock_filename, 'w');
100
101                // Acquire exclusive write lock to lock file
102                flock($this->lock, LOCK_EX);
103
104                // Create dbm-file if needed
105                if (!file_exists($dbm_filename)) {
106                        if (!touch($dbm_filename)) {
107                                throw new Exception('failed to create dbm file: '.$dbm_filename);
108                        }
109                }
110
111                // Try to open dbm file for writing
112                $this->dba = dba_open($dbm_filename, 'w', $cache_type);
113                if (!$this->dba) {
114
115                        // Failed - create new dbm file
116                        $this->dba = dba_open($dbm_filename, 'n', $cache_type);
117
118                        if (!$this->dba) {
119                                throw new Exception('failed to create dbm file: '.$dbm_filename);
120                        }
121
122                        // Insert getID3 version number
123                        dba_insert(getID3::VERSION, getID3::VERSION, $this->dba);
124                }
125
126                // Init misc values
127                $this->cache_type   = $cache_type;
128                $this->dbm_filename = $dbm_filename;
129
130                // Register destructor
131                register_shutdown_function(array($this, '__destruct'));
132
133                // Check version number and clear cache if changed
134                if (dba_fetch(getID3::VERSION, $this->dba) != getID3::VERSION) {
135                        $this->clear_cache();
136                }
137
138                parent::getID3();
139        }
140
141
142
143        // public: destructor
144        public function __destruct() {
145
146                // Close dbm file
147                dba_close($this->dba);
148
149                // Release exclusive lock
150                flock($this->lock, LOCK_UN);
151
152                // Close lock file
153                fclose($this->lock);
154        }
155
156
157
158        // public: clear cache
159        public function clear_cache() {
160
161                // Close dbm file
162                dba_close($this->dba);
163
164                // Create new dbm file
165                $this->dba = dba_open($this->dbm_filename, 'n', $this->cache_type);
166
167                if (!$this->dba) {
168                        throw new Exception('failed to clear cache/recreate dbm file: '.$this->dbm_filename);
169                }
170
171                // Insert getID3 version number
172                dba_insert(getID3::VERSION, getID3::VERSION, $this->dba);
173
174                // Re-register shutdown function
175                register_shutdown_function(array($this, '__destruct'));
176        }
177
178
179
180        // public: analyze file
181        public function analyze($filename) {
182
183                if (file_exists($filename)) {
184
185                        // Calc key     filename::mod_time::size    - should be unique
186                        $key = $filename.'::'.filemtime($filename).'::'.filesize($filename);
187
188                        // Loopup key
189                        $result = dba_fetch($key, $this->dba);
190
191                        // Hit
192                        if ($result !== false) {
193                                return unserialize($result);
194                        }
195                }
196
197                // Miss
198                $result = parent::analyze($filename);
199
200                // Save result
201                if (file_exists($filename)) {
202                        dba_insert($key, serialize($result), $this->dba);
203                }
204
205                return $result;
206        }
207
208}
Note: See TracBrowser for help on using the repository browser.