1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Core
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * File storage database resource resource model class
 30:  *
 31:  * @category    Mage
 32:  * @package     Mage_Core
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Core_Model_Resource_File_Storage_Database extends Mage_Core_Model_Resource_File_Storage_Abstract
 36: {
 37:     /**
 38:      * Define table name and id field for resource
 39:      */
 40:     protected function _construct()
 41:     {
 42:         $this->_init('core/file_storage', 'file_id');
 43:     }
 44: 
 45:     /**
 46:      * Create database scheme for storing files
 47:      *
 48:      * @return Mage_Core_Model_Resource_File_Storage_Database
 49:      */
 50:     public function createDatabaseScheme()
 51:     {
 52:         $adapter = $this->_getWriteAdapter();
 53:         $table = $this->getMainTable();
 54:         if ($adapter->isTableExists($table)) {
 55:             return $this;
 56:         }
 57: 
 58:         $dirStorageTable = $this->getTable('core/directory_storage'); // For foreign key
 59: 
 60:         $ddlTable = $adapter->newTable($table)
 61:             ->addColumn('file_id', Varien_Db_Ddl_Table::TYPE_INTEGER, null, array(
 62:                 'identity'  => true,
 63:                 'unsigned'  => true,
 64:                 'nullable'  => false,
 65:                 'primary'   => true
 66:                 ), 'File Id')
 67:             ->addColumn('content', Varien_Db_Ddl_Table::TYPE_VARBINARY, Varien_Db_Ddl_Table::MAX_VARBINARY_SIZE, array(
 68:                 'nullable' => false
 69:                 ), 'File Content')
 70:             ->addColumn('upload_time', Varien_Db_Ddl_Table::TYPE_TIMESTAMP, null, array(
 71:                 'nullable' => false,
 72:                 'default' => Varien_Db_Ddl_Table::TIMESTAMP_INIT
 73:                 ), 'Upload Timestamp')
 74:             ->addColumn('filename', Varien_Db_Ddl_Table::TYPE_TEXT, 100, array(
 75:                 'nullable' => false
 76:                 ), 'Filename')
 77:             ->addColumn('directory_id', Varien_Db_Ddl_Table::TYPE_INTEGER, null, array(
 78:                 'unsigned' => true,
 79:                 'default' => null
 80:                 ), 'Identifier of Directory where File is Located')
 81:             ->addColumn('directory', Varien_Db_Ddl_Table::TYPE_TEXT, 255, array(
 82:                 'default' => null
 83:                 ), 'Directory Path')
 84:             ->addIndex($adapter->getIndexName($table, array('filename', 'directory_id'),
 85:                 Varien_Db_Adapter_Interface::INDEX_TYPE_UNIQUE),
 86:                 array('filename', 'directory_id'), array('type' => Varien_Db_Adapter_Interface::INDEX_TYPE_UNIQUE))
 87:             ->addIndex($adapter->getIndexName($table, array('directory_id')), array('directory_id'))
 88:             ->addForeignKey($adapter->getForeignKeyName($table, 'directory_id', $dirStorageTable, 'directory_id'),
 89:                 'directory_id', $dirStorageTable, 'directory_id',
 90:                 Varien_Db_Ddl_Table::ACTION_CASCADE, Varien_Db_Ddl_Table::ACTION_CASCADE)
 91:             ->setComment('File Storage');
 92: 
 93:         $adapter->createTable($ddlTable);
 94:         return $this;
 95:     }
 96: 
 97:     /**
 98:      * Decodes blob content retrieved by DB driver
 99:      *
100:      * @param  array $row Table row with 'content' key in it
101:      * @return array
102:      */
103:     protected function _decodeFileContent($row)
104:     {
105:         $row['content'] = $this->_getReadAdapter()->decodeVarbinary($row['content']);
106:         return $row;
107:     }
108: 
109:     /**
110:      * Decodes blob content retrieved by Database driver
111:      *
112:      * @param  array $rows Array of table rows (files), each containing 'content' key
113:      * @return array
114:      */
115:     protected function _decodeAllFilesContent($rows)
116:     {
117:         foreach ($rows as $key => $row) {
118:             $rows[$key] = $this->_decodeFileContent($row);
119:         }
120:         return $rows;
121:     }
122: 
123:     /**
124:      * Load entity by filename
125:      *
126:      * @param  Mage_Core_Model_File_Storage_Database $object
127:      * @param  string $filename
128:      * @param  string $path
129:      * @return Mage_Core_Model_Mysql4_File_Storage_Database
130:      */
131:     public function loadByFilename(Mage_Core_Model_File_Storage_Database $object, $filename, $path)
132:     {
133:         $adapter = $this->_getReadAdapter();
134: 
135:         $select = $adapter->select()
136:             ->from(array('e' => $this->getMainTable()))
137:             ->where('filename = ?', $filename)
138:             ->where($adapter->prepareSqlCondition('directory', array('seq' => $path)));
139: 
140:         $row = $adapter->fetchRow($select);
141:         if ($row) {
142:             $row = $this->_decodeFileContent($row);
143:             $object->setData($row);
144:             $this->_afterLoad($object);
145:         }
146: 
147:         return $this;
148:     }
149: 
150:     /**
151:      * Clear files in storage
152:      *
153:      * @return Mage_Core_Model_Mysql4_File_Storage_Database
154:      */
155:     public function clearFiles()
156:     {
157:         $adapter = $this->_getWriteAdapter();
158:         $adapter->delete($this->getMainTable());
159: 
160:         return $this;
161:     }
162: 
163:     /**
164:      * Get files from storage at defined range
165:      *
166:      * @param  int $offset
167:      * @param  int $count
168:      * @return array
169:      */
170:     public function getFiles($offset = 0, $count = 100)
171:     {
172:         $adapter = $this->_getReadAdapter();
173: 
174:         $select = $adapter->select()
175:             ->from(
176:                 array('e' => $this->getMainTable()),
177:                 array('filename', 'content', 'directory')
178:             )
179:             ->order('file_id')
180:             ->limit($count, $offset);
181: 
182:         $rows = $adapter->fetchAll($select);
183:         return $this->_decodeAllFilesContent($rows);
184:     }
185: 
186:     /**
187:      * Save file to storage
188:      *
189:      * @param  Mage_Core_Model_File_Storage_Database|array $object
190:      * @return Mage_Core_Model_Mysql4_File_Storage_Database
191:      */
192:     public function saveFile($file)
193:     {
194:         $adapter = $this->_getWriteAdapter();
195: 
196:         $contentParam = new Varien_Db_Statement_Parameter($file['content']);
197:         $contentParam->setIsBlob(true);
198:         $data = array(
199:             'content'        => $contentParam,
200:             'upload_time'    => $file['update_time'],
201:             'filename'       => $file['filename'],
202:             'directory_id'   => $file['directory_id'],
203:             'directory'      => $file['directory']
204:         );
205: 
206:         $adapter->insertOnDuplicate($this->getMainTable(), $data, array('content', 'upload_time'));
207: 
208:         return $this;
209:     }
210: 
211:     /**
212:      * Rename files in database
213:      *
214:      * @param  string $oldFilename
215:      * @param  string $oldPath
216:      * @param  string $newFilename
217:      * @param  string $newPath
218:      * @return Mage_Core_Model_Mysql4_File_Storage_Database
219:      */
220:     public function renameFile($oldFilename, $oldPath, $newFilename, $newPath)
221:     {
222:         $adapter    = $this->_getWriteAdapter();
223:         $dataUpdate = array('filename' => $newFilename, 'directory' => $newPath);
224: 
225:         $dataWhere  = array('filename = ?' => $oldFilename);
226:         $dataWhere[] = new Zend_Db_Expr($adapter->prepareSqlCondition('directory', array('seq' => $oldPath)));
227: 
228:         $adapter->update($this->getMainTable(), $dataUpdate, $dataWhere);
229: 
230:         return $this;
231:     }
232: 
233:     /**
234:      * Copy files in database
235:      *
236:      * @param  string $oldFilename
237:      * @param  string $oldPath
238:      * @param  string $newFilename
239:      * @param  string $newPath
240:      * @return Mage_Core_Model_Mysql4_File_Storage_Database
241:      */
242:     public function copyFile($oldFilename, $oldPath, $newFilename, $newPath)
243:     {
244:         $adapter = $this->_getReadAdapter();
245: 
246:         $select = $adapter->select()
247:             ->from(array('e' => $this->getMainTable()))
248:             ->where('filename = ?', $oldFilename)
249:             ->where($adapter->prepareSqlCondition('directory', array('seq' => $oldPath)));
250: 
251:         $data = $adapter->fetchRow($select);
252:         if (!$data) {
253:             return $this;
254:         }
255: 
256:         if (isset($data['file_id']) && isset($data['filename'])) {
257:             unset($data['file_id']);
258:             $data['filename'] = $newFilename;
259:             $data['directory'] = $newPath;
260: 
261:             $writeAdapter = $this->_getWriteAdapter();
262:             $writeAdapter->insertOnDuplicate($this->getMainTable(), $data, array('content', 'upload_time'));
263:         }
264: 
265:         return $this;
266:     }
267: 
268:     /**
269:      * Check whether file exists in DB
270:      *
271:      * @param string $filename
272:      * @param string $path
273:      * @return bool
274:      */
275:     public function fileExists($filename, $path)
276:     {
277:         $adapter = $this->_getReadAdapter();
278: 
279:         $select = $adapter->select()
280:             ->from(array('e' => $this->getMainTable()))
281:             ->where('filename = ?', $filename)
282:             ->where($adapter->prepareSqlCondition('directory', array('seq' => $path)))
283:             ->limit(1);
284: 
285:         $data = $adapter->fetchRow($select);
286:         return (bool)$data;
287:     }
288: 
289:     /**
290:      * Delete files that starts with given $folderName
291:      *
292:      * @param string $folderName
293:      */
294:     public function deleteFolder($folderName = '')
295:     {
296:         $folderName = rtrim($folderName, '/');
297:         if (!strlen($folderName)) {
298:             return;
299:         }
300: 
301:         /* @var $resHelper Mage_Core_Model_Resource_Helper_Abstract */
302:         $resHelper = Mage::getResourceHelper('core');
303:         $likeExpression = $resHelper->addLikeEscape($folderName . '/', array('position' => 'start'));
304:         $this->_getWriteAdapter()
305:             ->delete($this->getMainTable(), new Zend_Db_Expr('filename LIKE ' . $likeExpression));
306:     }
307: 
308:     /**
309:      * Delete file
310:      *
311:      * @param string $filename
312:      * @param string $directory
313:      */
314:     public function deleteFile($filename, $directory)
315:     {
316:         $adapter = $this->_getWriteAdapter();
317: 
318:         $where = array('filename = ?' => $filename);
319:         $where[] = new Zend_Db_Expr($adapter->prepareSqlCondition('directory', array('seq' => $directory)));
320: 
321:         $adapter->delete($this->getMainTable(), $where);
322:     }
323: 
324:     /**
325:      * Return directory file listing
326:      *
327:      * @param string $directory
328:      * @return mixed
329:      */
330:     public function getDirectoryFiles($directory)
331:     {
332:         $directory = trim($directory, '/');
333:         $adapter = $this->_getReadAdapter();
334: 
335:         $select = $adapter->select()
336:             ->from(
337:                 array('e' => $this->getMainTable()),
338:                 array(
339:                     'filename',
340:                     'directory',
341:                     'content'
342:                 )
343:             )
344:             ->where($adapter->prepareSqlCondition('directory', array('seq' => $directory)))
345:             ->order('file_id');
346: 
347:         $rows = $adapter->fetchAll($select);
348:         return $this->_decodeAllFilesContent($rows);
349:     }
350: }
351: