ecommun / owncloud_ynh

Blame view

sources/3rdparty/getid3/extension.cache.dbm.php 5.79 KB
edit raw normal view history
03e52840d   Kload   Init 
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
 
  <?php
  /////////////////////////////////////////////////////////////////
  /// getID3() by James Heinrich <info@getid3.org>               //
  //  available at http://getid3.sourceforge.net                 //
  //            or http://www.getid3.org                         //
  /////////////////////////////////////////////////////////////////
  //                                                             //
  // extension.cache.dbm.php - part of getID3()                  //
  // Please see readme.txt for more information                  //
  //                                                            ///
  /////////////////////////////////////////////////////////////////
  //                                                             //
  // This extension written by Allan Hansen <ahØartemis*dk>      //
  //                                                            ///
  /////////////////////////////////////////////////////////////////
  
  
  /**
  * This is a caching extension for getID3(). It works the exact same
  * way as the getID3 class, but return cached information very fast
  *
  * Example:
  *
  *    Normal getID3 usage (example):
  *
  *       require_once 'getid3/getid3.php';
  *       $getID3 = new getID3;
  *       $getID3->encoding = 'UTF-8';
  *       $info1 = $getID3->analyze('file1.flac');
  *       $info2 = $getID3->analyze('file2.wv');
  *
  *    getID3_cached usage:
  *
  *       require_once 'getid3/getid3.php';
  *       require_once 'getid3/getid3/extension.cache.dbm.php';
  *       $getID3 = new getID3_cached('db3', '/tmp/getid3_cache.dbm',
  *                                          '/tmp/getid3_cache.lock');
  *       $getID3->encoding = 'UTF-8';
  *       $info1 = $getID3->analyze('file1.flac');
  *       $info2 = $getID3->analyze('file2.wv');
  *
  *
  * Supported Cache Types
  *
  *   SQL Databases:          (use extension.cache.mysql)
  *
  *   cache_type          cache_options
  *   -------------------------------------------------------------------
  *   mysql               host, database, username, password
  *
  *
  *   DBM-Style Databases:    (this extension)
  *
  *   cache_type          cache_options
  *   -------------------------------------------------------------------
  *   gdbm                dbm_filename, lock_filename
  *   ndbm                dbm_filename, lock_filename
  *   db2                 dbm_filename, lock_filename
  *   db3                 dbm_filename, lock_filename
  *   db4                 dbm_filename, lock_filename  (PHP5 required)
  *
  *   PHP must have write access to both dbm_filename and lock_filename.
  *
  *
  * Recommended Cache Types
  *
  *   Infrequent updates, many reads      any DBM
  *   Frequent updates                    mysql
  */
  
  
  class getID3_cached_dbm extends getID3
  {
  
  	// public: constructor - see top of this file for cache type and cache_options
31b7f2792   Kload   Upgrade to ownclo... 
76
 
  	public function getID3_cached_dbm($cache_type, $dbm_filename, $lock_filename) {
03e52840d   Kload   Init 
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
 
  
  		// Check for dba extension
  		if (!extension_loaded('dba')) {
  			throw new Exception('PHP is not compiled with dba support, required to use DBM style cache.');
  		}
  
  		// Check for specific dba driver
  		if (!function_exists('dba_handlers') || !in_array($cache_type, dba_handlers())) {
  			throw new Exception('PHP is not compiled --with '.$cache_type.' support, required to use DBM style cache.');
  		}
  
  		// Create lock file if needed
  		if (!file_exists($lock_filename)) {
  			if (!touch($lock_filename)) {
  				throw new Exception('failed to create lock file: '.$lock_filename);
  			}
  		}
  
  		// Open lock file for writing
  		if (!is_writeable($lock_filename)) {
  			throw new Exception('lock file: '.$lock_filename.' is not writable');
  		}
  		$this->lock = fopen($lock_filename, 'w');
  
  		// Acquire exclusive write lock to lock file
  		flock($this->lock, LOCK_EX);
  
  		// Create dbm-file if needed
  		if (!file_exists($dbm_filename)) {
  			if (!touch($dbm_filename)) {
  				throw new Exception('failed to create dbm file: '.$dbm_filename);
  			}
  		}
  
  		// Try to open dbm file for writing
  		$this->dba = dba_open($dbm_filename, 'w', $cache_type);
  		if (!$this->dba) {
  
  			// Failed - create new dbm file
  			$this->dba = dba_open($dbm_filename, 'n', $cache_type);
  
  			if (!$this->dba) {
  				throw new Exception('failed to create dbm file: '.$dbm_filename);
  			}
  
  			// Insert getID3 version number
  			dba_insert(getID3::VERSION, getID3::VERSION, $this->dba);
  		}
  
  		// Init misc values
  		$this->cache_type   = $cache_type;
  		$this->dbm_filename = $dbm_filename;
  
  		// Register destructor
  		register_shutdown_function(array($this, '__destruct'));
  
  		// Check version number and clear cache if changed
  		if (dba_fetch(getID3::VERSION, $this->dba) != getID3::VERSION) {
  			$this->clear_cache();
  		}
  
  		parent::getID3();
  	}
31b7f2792   Kload   Upgrade to ownclo... 
140
141
 
  	// public: destructor
  	public function __destruct() {
03e52840d   Kload   Init 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
  
  		// Close dbm file
  		dba_close($this->dba);
  
  		// Release exclusive lock
  		flock($this->lock, LOCK_UN);
  
  		// Close lock file
  		fclose($this->lock);
  	}
  
  
  
  	// public: clear cache
31b7f2792   Kload   Upgrade to ownclo... 
156
 
  	public function clear_cache() {
03e52840d   Kload   Init 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
  
  		// Close dbm file
  		dba_close($this->dba);
  
  		// Create new dbm file
  		$this->dba = dba_open($this->dbm_filename, 'n', $this->cache_type);
  
  		if (!$this->dba) {
  			throw new Exception('failed to clear cache/recreate dbm file: '.$this->dbm_filename);
  		}
  
  		// Insert getID3 version number
  		dba_insert(getID3::VERSION, getID3::VERSION, $this->dba);
  
  		// Re-register shutdown function
  		register_shutdown_function(array($this, '__destruct'));
  	}
  
  
  
  	// public: analyze file
31b7f2792   Kload   Upgrade to ownclo... 
178
 
  	public function analyze($filename) {
03e52840d   Kload   Init 
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
 
  
  		if (file_exists($filename)) {
  
  			// Calc key     filename::mod_time::size    - should be unique
  			$key = $filename.'::'.filemtime($filename).'::'.filesize($filename);
  
  			// Loopup key
  			$result = dba_fetch($key, $this->dba);
  
  			// Hit
  			if ($result !== false) {
  				return unserialize($result);
  			}
  		}
  
  		// Miss
  		$result = parent::analyze($filename);
  
  		// Save result
  		if (file_exists($filename)) {
  			dba_insert($key, serialize($result), $this->dba);
  		}
  
  		return $result;
  	}
  
  }