-
Notifications
You must be signed in to change notification settings - Fork 0
/
eck.install
469 lines (399 loc) · 14.2 KB
/
eck.install
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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
<?php
/**
* @file
* This install file creates a table for the this module to store information
* about entities. Well, the only information that it needs to store is a name
* and a label for each entity created, the rest of the information is generated
* by the functions.
*
* eck__entity_info
* efacoty__entity_schema
* eck__entity_menu
*
* in eck.module
*/
/**
* TODO: Currently when the module is uninstalled, the tables of Entities that
* were left behind are still around, can we warn the user when they are trying
* to uninstall about the left over entities that are being managed?
*/
/**
* Implements hook_schema().
*
* Create the database table that will store the entities information.
* All that we need for each entity is a name and a label
*/
function eck_schema() {
$schema = array();
// Schema for the eck table.
$schema['eck_entity_type'] = array(
'description' => "The base table for entity type information",
'fields' => array(
'id' => array(
'description' => "The primary identifier for a bundle",
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'name' => array(
'description' => "The machine name of the entity",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'label' => array(
'description' => "The entity's Label",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'properties' => array(
'type' => 'text',
'not null' => TRUE,
'serialize' => TRUE,
'initial' => serialize(array()),
'description' => 'A serialized list of properties attached to this entity.',
),
/*DON'T NEED THIS ANY LONGER
* 'custom_properties' => array(
'type' => 'text',
'not null' => TRUE,
'serialize' => TRUE,
'initial' => serialize(array()),
'description' => 'A serialized list of custom properties attached to this entity.',
)*/
),
'primary key' => array('id', 'name'),
'indexes' => array()
);
$schema['eck_bundle'] = array(
'description' => "The base table for bundle information",
'fields' => array(
/*Really the identifier should be some sort of combination between'
* the entity type the bundle belongs too, and the bundles name
* but since I don't know db stuff to that extent, i will leave this
* useless id hanging around , well it seems liek CTools exportable
* do expect some sort of id beyond the machina_name, so we will
* leave here and added back to the types, just in case that we
* use CTools exportables*/
'id' => array(
'description' => "The primary identifier for a bundle",
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'machine_name' => array(
'description' => "A combination of the entity type and the name of
this bundle, this combination is unique",
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'entity_type' => array(
'description' => "The entity type this bundle belongs to",
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'name' => array(
'description' => "The bundle's name",
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'label' => array(
'description' => "A human readable name for the bundle (not that the type is not human readable)",
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
)
),
'primary key' => array('id'/*, 'machine_name'*/), //sad.. taken this out until I figure out how to make it work
'indexes' => array(
/*'entity_type_bundle' => array('entity_type', 'name'),*/ //Nope, Don't need it
),
);
// At the installation stage, eck has not been created, so what is this for?
// The schema is not only used during installation, it is used at many other
// stages and by many other processes withing drupal. Because we are creating
// tables dynamically with eck, we need to expose those schemas through this
// function, that is why we are doing this.
return $schema;
}
/**
* Update 7000
*/
function eck_update_7000() {
// To implement bundles (types), I have decided to have one table that will
// hold all of the types information. So for this update we need to create the
// table, and add all of the current entities with their types to the table,
// so we can unify the implementations of bundles in code.
$schema = array(
'description' => "The base table for entities types information",
'fields' => array(
'id' => array(
'description' => "The primary identifier for a(n) entity type",
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'entity' => array(
'description' => "The entity this type belongs to",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'type' => array(
'description' => "The type (bundle) name that will be used",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
),
'label' => array(
'description' => "A human readable name for the bundle (not that the type is not human readable)",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
)
),
'primary key' => array('id'),
'indexes' => array(
'entity_type' => array('entity', 'type'),
),
);
db_create_table('eck_types', $schema);
// Now we add a type (bundle) to the table for each entity in the eck table.
$results = db_select('eck', 't')->fields('t')->execute();
foreach ($results as $record) {
$nid = db_insert('eck_types')
->fields(array(
'entity' => $record->name,
'type' => $record->name,
'label' => $record->label,
))
->execute();
// Also we want to add a field to all the enity tables for the type, and
// populated with the current type.
db_add_field("eck_{$record->name}", 'type', array(
'description' => 'The type of the entity',
'type' => 'varchar',
'default' => '',
'length' => 255,
'not null' => TRUE,
'initial' => $record->name
));
}
}
/**
* Update 7001
*/
function eck_update_7001() {
// For importing and exporting things it is always good to have a uuid, so we
// will add that colunm to the current entity types.
// Now we add a type (bundle) to the table for each entity in the eck table.
$results = db_select('eck', 't')->fields('t')->execute();
foreach ($results as $record) {
// Also we want to add a field to all the enity tables for the type, and
// populated with the current type.
db_add_field("eck_{$record->name}", 'uuid', array(
'type' => 'char',
'length' => 36,
'not null' => TRUE,
'default' => '',
'description' => 'The Universally Unique Identifier.'
));
}
}
function eck_update_7002() {
// The more I think about it, the more it makes sense to replicate the
// "status" property from nodes, this is just a flag that lets the system know
// whether a piece of data should be seen by the public or not. Instead of a
// boolean, I think that a int instead of boolean could be more useful, that
// way more complicated workflows can be implemented. For example if a piece
// of data needs to be reviewed before showing it to the public, and int can
// campture those different states: 0- don't show 1 - show 3 - needs review 4
// - revised by editor, etc. Also instead of status, I think that "state" is a
// more appropiate name.
$results = db_select('eck', 't')->fields('t')->execute();
foreach ($results as $record) {
db_add_field("eck_{$record->name}", 'state', array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The state of the entity'
));
}
}
/**
* Adds the properties column to the eck table.
*/
function eck_update_7003() {
db_add_field('eck', 'properties', array(
'type' => 'text',
'not null' => TRUE,
'serialize' => TRUE,
'initial' => serialize(array(
'uuid' => 1,
'uid' => 1,
'created' => 1,
'changed' => 1,
'state' => 1
)),
'description' => 'A serialized list of additional properties attached to this entity.',
));
}
/**
* Adds the custom properties column to the eck table.
*/
function eck_update_7004() {
db_add_field('eck', 'custom_properties', array(
'type' => 'text',
'not null' => TRUE,
'serialize' => TRUE,
'initial' => serialize(array()),
'description' => 'A serialized list of custom properties attached to this entity.',
));
}
function eck_update_7005() {
//change the name of the eck table to eck_entity_type
db_rename_table('eck', 'eck_entity_type');
//change the name of the eck_types table to eck_bundle
db_rename_table('eck_types', 'eck_bundle');
//remove the id key from eck_entity_type
db_drop_field('eck_entity_type', 'id');
//create the index with the right field names
db_add_primary_key('eck_entity_type', array('name'));
//drop the eck_bundle index entity_type
db_drop_index('eck_bundle', 'entity_type');
//change eck_bundle entity field to entity_type
db_change_field('eck_bundle', 'entity', 'entity_type',
array(
'description' => "The entity type this bundle belongs to",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
)
);
//change eck_bundle type field to name
db_change_field('eck_bundle', 'type', 'name',
array(
'description' => "The bundle's name",
'type' => 'varchar',
'type' => 'varchar',
'length' => 128,
'not null' => TRUE
)
);
//create the index with the right field names
db_add_index('eck_bundle', 'entity_type_bundle_name', array('entity_type', 'name'));
}
function eck_update_7006() {
//lets start with then entity type table
//lets add an id field to the entity_type table, and set it up as a primary key
//db_add_primary_key('eck_entity_type', array('id'));
db_drop_primary_key('eck_entity_type');
db_add_field('eck_entity_type', 'id', array(
'description' => "The primary identifier for an entity type",
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
), array('primary key' => array('id', 'name')));
//lets take the properties and translate them to the new form.
$results = db_select('eck_entity_type', 't')->fields('t')->execute();
foreach ($results as $record) {
//@todo for each entity type we want to drop all the indexes.. they will have to be managed dynamically by the
//behaviors even though I don't know how to do that yet
$entity_table = "eck_{$record->name}";
if(db_index_exists($entity_table, 'uid')){
db_drop_index($entity_table, 'uid');
}
if(db_index_exists($entity_table, "{$record->name}_created")){
db_drop_index($entity_table, "{$record->name}_created");
}
if(db_index_exists($entity_table, "{$record->name}_changed")){
db_drop_index($entity_table, "{$record->name}_changed");
}
$new_properties = array();
$properties = $record->properties;
$properties = unserialize($properties);
foreach($properties as $property => $status){
switch($property){
case 'uuid':
$new_properties['uuid'] = array('label' => 'UUID', 'type' => 'uuid');
break;
case 'uid':
$new_properties['uid'] = array('label' => 'Author', 'type' => 'integer', 'behavior' => 'author');
break;
case 'created':
$new_properties['created'] = array('label' => 'Created', 'type' => 'integer', 'behavior' => 'created');
break;
case 'changed':
$new_properties['changed'] = array('label' => 'Changed', 'type' => 'integer', 'behavior' => 'changed');
break;
case 'state':
$new_properties['state'] = array('label' => 'State', 'type' => 'positive_integer');
break;
}
}
$custom_properties = $record->custom_properties;
$custom_properties = unserialize($custom_properties);
foreach($custom_properties as $property => $info){
$type = $info['type'];
$label = $info['label'];
switch($type){
case 'text':
$new_properties[$property] = array('label' => $label, 'type' => $type);
break;
case 'decimal':
$new_properties[$property] = array('label' => $label, 'type' => $type);
break;
default:
$new_properties[$property] = array('label' => $label, 'type' => 'integer');
break;
}
}
$encode_new = drupal_json_encode($new_properties);
db_update('eck_entity_type') // Table name no longer needs {}
->fields(array(
'properties' => $encode_new
))
->condition('name', $record->name, '=')
->execute();
}
//Now we can drop the custom_properties field now that everything has been moved
db_drop_field('eck_entity_type', 'custom_properties');
//now the changes to the eck_bundle table
//first lets drop that index
db_drop_index('eck_bundle', 'entity_type_bundle_name');
db_add_field('eck_bundle', 'machine_name', array(
'description' => "A combination of the entity type and the name of
this bundle, this combination is unique",
'type' => 'varchar',
'length' => 128,
'default' =>"",
'not null' => TRUE
));
//
}
function eck_update_7007() {
//lets generate the machine names for each bundle
$results = db_select('eck_bundle', 't')->fields('t')->execute();
foreach ($results as $record) {
$name = $record->name;
$entity_type = $record->entity_type;
$record->machine_name = "{$entity_type}_{$name}";
db_update('eck_bundle') // Table name no longer needs {}
->fields(array(
'machine_name' => $record->machine_name
))
->condition('id', $record->id, '=')
->execute();
}
}