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
|
<?php
/**
* PHPPgAdmin v6.0.0-RC1
*/
namespace PHPPgAdmin\Database\Traits;
/**
* Common trait for views manipulation.
*/
trait ViewTrait
{
/**
* Returns a list of all views in the database.
*
* @return \PHPPgAdmin\ADORecordSet All views
*/
public function getViews()
{
$c_schema = $this->_schema;
$this->clean($c_schema);
$sql = "
SELECT c.relname, pg_catalog.pg_get_userbyid(c.relowner) AS relowner,
pg_catalog.obj_description(c.oid, 'pg_class') AS relcomment
FROM pg_catalog.pg_class c
LEFT JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)
WHERE (n.nspname='{$c_schema}') AND (c.relkind = 'v'::\"char\")
ORDER BY relname";
return $this->selectSet($sql);
}
/**
* Returns a list of all materialized views in the database.
*
* @return \PHPPgAdmin\ADORecordSet All materialized views
*/
public function getMaterializedViews()
{
$c_schema = $this->_schema;
$this->clean($c_schema);
$sql = "
SELECT c.relname, pg_catalog.pg_get_userbyid(c.relowner) AS relowner,
pg_catalog.obj_description(c.oid, 'pg_class') AS relcomment
FROM pg_catalog.pg_class c
LEFT JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)
WHERE (n.nspname='{$c_schema}') AND (c.relkind = 'm'::\"char\")
ORDER BY relname";
return $this->selectSet($sql);
}
/**
* Updates a view.
*
* @param string $viewname The name fo the view to update
* @param string $definition The new definition for the view
* @param string $comment
* @param bool $materialized tells if it's a materialized view or not
*
* @return bool|int 0 success
*/
public function setView($viewname, $definition, $comment, $materialized = false)
{
return $this->createView($viewname, $definition, true, $comment, $materialized);
}
/**
* Creates a new view.
*
* @param string $viewname The name of the view to create
* @param string $definition The definition for the new view
* @param bool $replace True to replace the view, false otherwise
* @param string $comment
* @param bool $materialized tells if it's a materialized view
*
* @return bool|int 0 success
*/
public function createView($viewname, $definition, $replace, $comment, $materialized = false)
{
$status = $this->beginTransaction();
if ($status != 0) {
return -1;
}
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($viewname);
// Note: $definition not cleaned
$sql = 'CREATE ';
$sql .= $replace ? ' OR REPLACE ' : ' ';
$obj_type = $materialized ? ' MATERIALIZED VIEW ' : ' VIEW ';
$sql .= $obj_type." \"{$f_schema}\".\"{$viewname}\" AS {$definition}";
$status = $this->execute($sql);
if ($status) {
$this->rollbackTransaction();
return -1;
}
if ($comment != '') {
$status = $this->setComment($obj_type, $viewname, '', $comment);
if ($status) {
$this->rollbackTransaction();
return -1;
}
}
return $this->endTransaction();
}
/**
* Alter view properties.
*
* @param string $view The name of the view
* @param string $name The new name for the view
* @param string $owner The new owner for the view
* @param string $schema The new schema for the view
* @param string $comment The comment on the view
*
* @return bool|int 0 success
*/
public function alterView($view, $name, $owner, $schema, $comment)
{
$data = $this->getView($view);
if ($data->recordCount() != 1) {
return -2;
}
$status = $this->beginTransaction();
if ($status != 0) {
$this->rollbackTransaction();
return -1;
}
$status = $this->_alterView($data, $name, $owner, $schema, $comment);
if ($status != 0) {
$this->rollbackTransaction();
return $status;
}
return $this->endTransaction();
}
/**
* Returns all details for a particular view or materialized view.
*
* @param string $view The name of the view or materialized to retrieve
*
* @return \PHPPgAdmin\ADORecordSet [Materialized] View info
*/
public function getView($view)
{
$c_schema = $this->_schema;
$this->clean($c_schema);
$this->clean($view);
$sql = "
SELECT c.relname, n.nspname, pg_catalog.pg_get_userbyid(c.relowner) AS relowner,
pg_catalog.pg_get_viewdef(c.oid, true) AS vwdefinition,
pg_catalog.obj_description(c.oid, 'pg_class') AS relcomment,
c.relkind
FROM pg_catalog.pg_class c
LEFT JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)
WHERE (c.relname = '{$view}') AND n.nspname='{$c_schema}'";
return $this->selectSet($sql);
}
/**
* Protected method which alter a view
* SHOULDN'T BE CALLED OUTSIDE OF A TRANSACTION.
*
* @param \PHPPgAdmin\ADORecordSet $vwrs The view recordSet returned by getView()
* @param string $name The new name for the view
* @param string $owner The new owner for the view
* @param string $schema Schema name
* @param string $comment The comment on the view
*
* @return int 0 success
*/
protected function _alterView($vwrs, $name, $owner, $schema, $comment)
{
$this->fieldArrayClean($vwrs->fields);
$type = ($vwrs->fields['relkind'] === 'm') ? 'MATERIALIZED VIEW' : 'VIEW';
// Comment
if ($this->setComment($type, $vwrs->fields['relname'], '', $comment) != 0) {
return -4;
}
// Owner
$this->fieldClean($owner);
$status = $this->alterViewOwner($vwrs, $owner);
if ($status != 0) {
return -5;
}
// Rename
$this->fieldClean($name);
$status = $this->alterViewName($vwrs, $name);
if ($status != 0) {
return -3;
}
// Schema
$this->fieldClean($schema);
$status = $this->alterViewSchema($vwrs, $schema);
if ($status != 0) {
return -6;
}
return 0;
}
/**
* Alter a view's owner.
*
* @param \PHPPgAdmin\ADORecordSet $vwrs The view recordSet returned by getView()
* @param null|string $owner
*
* @return int 0 if operation was successful
*
* @internal param $name new view's owner
*/
public function alterViewOwner($vwrs, $owner = null)
{
$type = ($vwrs->fields['relkind'] === 'm') ? 'MATERIALIZED VIEW' : 'VIEW';
/* $vwrs and $owner are cleaned in _alterView */
if ((!empty($owner)) && ($vwrs->fields['relowner'] != $owner)) {
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
// If owner has been changed, then do the alteration. We are
// careful to avoid this generally as changing owner is a
// superuser only function.
$sql = "ALTER ${type} \"{$f_schema}\".\"{$vwrs->fields['relname']}\" OWNER TO \"{$owner}\"";
return $this->execute($sql);
}
return 0;
}
/**
* Rename a view.
*
* @param \PHPPgAdmin\ADORecordSet $vwrs The view recordSet returned by getView()
* @param string $name The new view's name
*
* @return int 0 if operation was successful
*/
public function alterViewName($vwrs, $name)
{
$type = ($vwrs->fields['relkind'] === 'm') ? 'MATERIALIZED VIEW' : 'VIEW';
// Rename (only if name has changed)
/* $vwrs and $name are cleaned in _alterView */
if (!empty($name) && ($name != $vwrs->fields['relname'])) {
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$sql = "ALTER ${type} \"{$f_schema}\".\"{$vwrs->fields['relname']}\" RENAME TO \"{$name}\"";
$status = $this->execute($sql);
if ($status == 0) {
$vwrs->fields['relname'] = $name;
} else {
return $status;
}
}
return 0;
}
/**
* Alter a view's schema.
*
* @param \PHPPgAdmin\ADORecordSet $vwrs The view recordSet returned by getView()
* @param string $schema
*
* @return int 0 if operation was successful
*
* @internal param The $name new view's schema
*/
public function alterViewSchema($vwrs, $schema)
{
$type = ($vwrs->fields['relkind'] === 'm') ? 'MATERIALIZED VIEW' : 'VIEW';
/* $vwrs and $schema are cleaned in _alterView */
if (!empty($schema) && ($vwrs->fields['nspname'] != $schema)) {
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
// If tablespace has been changed, then do the alteration. We
// don't want to do this unnecessarily.
$sql = "ALTER ${type} \"{$f_schema}\".\"{$vwrs->fields['relname']}\" SET SCHEMA \"{$schema}\"";
return $this->execute($sql);
}
return 0;
}
/**
* Drops a view.
*
* @param string $viewname The name of the view to drop
* @param string $cascade True to cascade drop, false to restrict
*
* @return int 0 if operation was successful
*/
public function dropView($viewname, $cascade)
{
$vwrs = $this->getView($viewname);
$type = ($vwrs->fields['relkind'] === 'm') ? 'MATERIALIZED VIEW' : 'VIEW';
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($viewname);
$sql = "DROP ${type} \"{$f_schema}\".\"{$viewname}\"";
if ($cascade) {
$sql .= ' CASCADE';
}
return $this->execute($sql);
}
abstract public function fieldClean(&$str);
abstract public function beginTransaction();
abstract public function rollbackTransaction();
abstract public function endTransaction();
abstract public function execute($sql);
abstract public function setComment($obj_type, $obj_name, $table, $comment, $basetype = null);
abstract public function selectSet($sql);
abstract public function clean(&$str);
abstract public function fieldArrayClean(&$arr);
}
|