aboutsummaryrefslogtreecommitdiffstats
path: root/lib/migration/content.php
blob: 400a46a434041c7d9a4799a214eb58beb0294f49 (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
<?php
/**
 * ownCloud
 *
 * @author Tom Needham
 * @copyright 2012 Tom Needham tom@owncloud.com
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library 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 library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


/**
 * provides methods to add and access data from the migration
 */
class OC_Migration_Content{

	private $zip=false;
	// Holds the MDB2 object
	private $db=null;
	// Holds an array of tmpfiles to delete after zip creation
	private $tmpfiles=array();

	/**
	* @brief sets up the
	* @param $zip ZipArchive object
	* @param optional $db a MDB2 database object (required for exporttype user)
	* @return bool
	*/
	public function __construct( $zip, $db=null ) {

		$this->zip = $zip;
		$this->db = $db;

	}

	// @brief prepares the db
	// @param $query the sql query to prepare
	public function prepare( $query ) {

		// Only add database to tmpfiles if actually used
		if( !is_null( $this->db ) ) {
			// Get db path
			$db = $this->db->getDatabase();
			if(!in_array($db, $this->tmpfiles)) {
				$this->tmpfiles[] = $db;
			}
		}

		// Optimize the query
		$query = $this->processQuery( $query );

		// Optimize the query
		$query = $this->db->prepare( $query );

		// Die if we have an error (error means: bad query, not 0 results!)
		if( PEAR::isError( $query ) ) {
			$entry = 'DB Error: "'.$query->getMessage().'"<br />';
			$entry .= 'Offending command was: '.$query.'<br />';
			OC_Log::write( 'migration', $entry, OC_Log::FATAL );
			return false;
		} else {
			return $query;
		}

	}

	/**
	* @brief processes the db query
	* @param $query the query to process
	* @return string of processed query
	*/
	private function processQuery( $query ) {
		$query = str_replace( '`', '\'', $query );
		$query = str_replace( 'NOW()', 'datetime(\'now\')', $query );
		$query = str_replace( 'now()', 'datetime(\'now\')', $query );
		// remove table prefixes
		$query = str_replace( '*PREFIX*', '', $query );
		return $query;
	}

	/**
	* @brief copys rows to migration.db from the main database
	* @param $options array of options.
	* @return bool
	*/
	public function copyRows( $options ) {
		if( !array_key_exists( 'table', $options ) ) {
			return false;
		}

		$return = array();

		// Need to include 'where' in the query?
		if( array_key_exists( 'matchval', $options ) && array_key_exists( 'matchcol', $options ) ) {

			// If only one matchval, create an array
			if(!is_array($options['matchval'])) {
				$options['matchval'] = array( $options['matchval'] );
			}

			foreach( $options['matchval'] as $matchval ) {
				// Run the query for this match value (where x = y value)
				$sql = 'SELECT * FROM `*PREFIX*' . $options['table'] . '` WHERE `' . $options['matchcol'] . '` LIKE ?';
				$query = OC_DB::prepare( $sql );
				$results = $query->execute( array( $matchval ) );
				$newreturns = $this->insertData( $results, $options );
				$return = array_merge( $return, $newreturns );
			}

		} else {
			// Just get everything
			$sql = 'SELECT * FROM `*PREFIX*' . $options['table'] . '`';
			$query = OC_DB::prepare( $sql );
			$results = $query->execute();
			$return = $this->insertData( $results, $options );

		}

		return $return;

	}

	/**
	* @brief saves a sql data set into migration.db
	* @param $data a sql data set returned from self::prepare()->query()
	* @param $options array of copyRows options
	* @return void
	*/
	private function insertData( $data, $options ) {
		$return = array();
		// Foreach row of data to insert
		while( $row = $data->fetchRow() ) {
			// Now save all this to the migration.db
			foreach($row as $field=>$value) {
				$fields[] = $field;
				$values[] = $value;
			}

			// Generate some sql
			$sql = "INSERT INTO `" . $options['table'] . '` ( `';
			$fieldssql = implode( '`, `', $fields );
			$sql .= $fieldssql . "` ) VALUES( ";
			$valuessql = substr( str_repeat( '?, ', count( $fields ) ), 0, -2 );
			$sql .= $valuessql . " )";
			// Make the query
			$query = $this->prepare( $sql );
			if( !$query ) {
				OC_Log::write( 'migration', 'Invalid sql produced: '.$sql, OC_Log::FATAL );
				return false;
				exit();
			} else {
				$query->execute( $values );
				// Do we need to return some values?
				if( array_key_exists( 'idcol', $options ) ) {
					// Yes we do
					$return[] = $row[$options['idcol']];
				} else {
					// Take a guess and return the first field :)
					$return[] = reset($row);
				}
			}
			$fields = '';
			$values = '';
		}
		return $return;
	}

	/**
	* @brief adds a directory to the zip object
	* @param $dir string path of the directory to add
	* @param $recursive bool
	* @param $internaldir string path of folder to add dir to in zip
	* @return bool
	*/
	public function addDir( $dir, $recursive=true, $internaldir='' ) {
		$dirname = basename($dir);
		$this->zip->addEmptyDir($internaldir . $dirname);
		$internaldir.=$dirname.='/';
		if( !file_exists( $dir ) ) {
			return false;
		}
		if ($dirhandle = opendir($dir)) {
			while (false !== ( $file = readdir($dirhandle))) {

				if (( $file != '.' ) && ( $file != '..' )) {

					if (is_dir($dir . '/' . $file) && $recursive) {
						$this->addDir($dir . '/' . $file, $recursive, $internaldir);
					} elseif (is_file($dir . '/' . $file)) {
						$this->zip->addFile($dir . '/' . $file, $internaldir . $file);
					}
				}
			}
			closedir($dirhandle);
		} else {
			OC_Log::write('admin_export', "Was not able to open directory: " . $dir, OC_Log::ERROR);
			return false;
		}
		return true;
	}

	/**
	* @brief adds a file to the zip from a given string
	* @param $data string of data to add
	* @param $path the relative path inside of the zip to save the file to
	* @return bool
	*/
	public function addFromString( $data, $path ) {
		// Create a temp file
		$file = tempnam( get_temp_dir(). '/', 'oc_export_tmp_' );
		$this->tmpfiles[] = $file;
		if( !file_put_contents( $file, $data ) ) {
			OC_Log::write( 'migation', 'Failed to save data to a temporary file', OC_Log::ERROR );
			return false;
		}
		// Add file to the zip
		$this->zip->addFile( $file, $path );
		return true;
	}

	/**
	* @brief closes the zip, removes temp files
	* @return bool
	*/
	public function finish() {
		if( !$this->zip->close() ) {
			OC_Log::write( 'migration',
				'Failed to write the zip file with error: '.$this->zip->getStatusString(),
				OC_Log::ERROR );
			return false;
		}
		$this->cleanup();
		return true;
	}

		/**
	* @brief cleans up after the zip
	*/
	private function cleanup() {
		// Delete tmp files
		foreach($this->tmpfiles as $i) {
			unlink( $i );
		}
	}
}