-
Notifications
You must be signed in to change notification settings - Fork 3
/
clone.module
333 lines (313 loc) · 10.5 KB
/
clone.module
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
<?php
/**
* @file
* Allow users to make a copy of an item of content (a node) and then edit that copy.
*/
/**
* Implements hook_config_info().
*/
function clone_config_info() {
$prefixes['clone.settings'] = array(
'label' => t('clone settings'),
'group' => t('Configuration'),
);
return $prefixes;
}
/**
* Implements hook_autoload_info()
*/
function clone_autoload_info() {
return array(
'views_handler_field_node_link_clone' => 'views/views_handler_field_node_link_clone.inc',
);
}
/**
* Implementation of hook_permission().
*/
function clone_permission() {
return array(
'clone node' => array('title' => t('Clone any node')),
'clone own nodes' => array('title' => t('Clone own nodes.')),
);
}
/**
* Implementation of hook_menu().
*/
function clone_menu() {
$items['admin/config/content/clone'] = array(
'access arguments' => array('administer site configuration'),
'page callback' => 'backdrop_get_form',
'page arguments' => array('clone_settings'),
'title' => 'Node Clone settings',
'file' => 'clone.pages.inc',
'description' => 'Allows users to clone (copy then edit) an existing node.',
);
$items['node/%node/clone/%clone_token'] = array(
'access callback' => 'clone_access_cloning',
'access arguments' => array(1, TRUE, 3),
'page callback' => 'clone_node_check',
'page arguments' => array(1),
'title' => 'Clone content',
'title callback' => 'clone_action_link_title',
'title arguments' => array(1),
'weight' => 5,
'file' => 'clone.pages.inc',
'type' => MENU_LOCAL_ACTION,
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
);
return $items;
}
/**
* Implements a to_arg function for the clone local action.
*
* @param string $arg
* The current argument value.
* @param array $map
* The path arguments.
*
* @return string
* Either 'confirm' or a CSRF token.
*/
function clone_token_to_arg($arg, $map) {
// Supply CSRF token if needed.
return clone_get_token($map[1]);
}
/**
* Get the token that needs to be added to the clone link.
*
* @param int $nid
* The node ID of the node to be cloned
*
* @return string
* Either 'confirm' or a CSRF token.
*/
function clone_get_token($nid) {
if (config_get('clone.settings', 'clone_nodes_without_confirm')) {
return backdrop_get_token('clone_access_cloning-' . $nid);
}
return 'confirm';
}
function clone_access_cloning($node, $check_token = FALSE, $token = FALSE) {
global $user;
// Check CSRF token if needed.
if ($check_token) {
if (!$token || $token !== clone_get_token($node->nid)) {
return FALSE;
}
}
// Check basic permissions first.
$access = clone_is_permitted($node->type) && (user_access('clone node') || ($user->uid && ($node->uid == $user->uid) && user_access('clone own nodes')));
// Make sure the user can view the original node content, and create a new one..
$access = $access && node_access('view', $node) && node_access('create', $node->type);
// Let other modules alter this.
backdrop_alter("clone_access", $access, $node);
return $access;
}
function clone_is_permitted($type) {
$omitted = config_get('clone.settings', 'clone_omitted');
return empty($omitted[$type]);
}
/**
* Menu title callback.
*/
function clone_action_link_title($node) {
// A hack to present a shorter title in contextual links.
if (current_path() != 'node/' . $node->nid) {
return t('Clone');
}
if (config_get('clone.settings', 'clone_use_node_type_name')) {
return t('Clone this !type', array('!type' => backdrop_strtolower(node_type_get_name($node))));
}
return t('Clone content');
}
/**
* Implementation of hook_node_type_delete().
*/
function clone_node_type_delete($info) {
// variable_del('clone_reset_' . $info->type);
}
/**
* Implementation of hook_node_type_update().
*/
function clone_node_type_update($info) {
if (!empty($info->old_type) && $info->old_type != $info->type) {
if (config_get('clone.settings', 'clone_reset_' . $info->old_type)) {
// variable_del('clone_reset_' . $info->old_type);
config_set('clone.settings', 'clone_reset_' . $info->type, TRUE);
}
}
}
/**
* Implements hook_views_api.
*/
function clone_views_api() {
return array(
'api' => 3,
'path' => backdrop_get_path('module', 'clone') . '/views',
);
}
/**
* Implementation of hook_admin_paths().
*/
function clone_admin_paths() {
if (config_get('system.core', 'node_admin_theme')) {
$paths = array(
'node/*/clone/*' => TRUE,
);
return $paths;
}
}
/**
* Implements hook_form_BASE_FORM_ID_alter().
*/
function clone_form_node_form_alter(&$form, $form_state, $form_id) {
// Add the clone_from_original_nid value for node forms triggered by cloning.
// This will make sure the clone_from_original_nid property is still
// attached to the node when passing through hook_node_insert().
if (!empty($form['#node']->clone_from_original_nid)) {
$form['clone_from_original_nid'] = array(
'#type' => 'value',
'#value' => $form['#node']->clone_from_original_nid,
);
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function clone_form_node_admin_content_alter(&$form, $form_state, $form_id) {
if (config_get('clone.settings', 'clone_method') == 'prepopulate') {
$destination = backdrop_get_destination();
}
else {
$destination = array();
}
// The property attribute changes in the $form array depending on the user role.
$property = isset($form['admin']['nodes']['#options']) ? '#options' : '#rows';
if (empty($form['admin']['nodes'][$property])) {
return;
}
// Expose a Clone operation on each node.
foreach ($form['admin']['nodes'][$property] as $nid => &$row) {
$node = node_load($nid);
if (clone_access_cloning($node)) {
// The structure of this form is different if there is just 1 or more
// than one operation.
if (!isset($row['operations']['data']['#links'])) {
$row['operations']['data']['#links'] = array();
$row['operations']['data']['#attributes']['class'] = array('links', 'inline');
$row['operations']['data']['#theme'] = 'links__node_operations';
if (isset($row['operations']['data']['#title'])) {
$title = $row['operations']['data']['#title'];
$row['operations']['data']['#links'][$title] = array(
'title' => $title,
'href' => $row['operations']['data']['#href'],
'query' => $row['operations']['data']['#options']['query'],
);
unset($row['operations']['data']['#type']);
}
}
$row['operations']['data']['#links']['clone'] = array(
'title' => t('clone'),
'href' => 'node/' . $nid . '/clone/' . clone_get_token($nid),
'query' => $destination,
);
}
}
}
/**
* Implements hook_action_info().
*/
function clone_action_info() {
return array(
'clone_action_clone' => array(
'type' => 'node',
'label' => t('Clone content'),
'configurable' => TRUE,
'hooks' => array('any' => TRUE),
'triggers' => array('any'),
),
);
}
/**
* Action callback.
*/
function clone_action_clone($original_node, $context) {
module_load_include('inc', 'clone', 'clone.pages');
if (clone_is_permitted($original_node->type)) {
$val = !empty($context['clone_context']) ? $context['clone_context'] : array();
$node = _clone_node_prepare($original_node, !empty($val['prefix_title']));
if (isset($val['substitute_from']) && strlen($val['substitute_from']) && isset($val['substitute_to'])) {
$i = (!empty($val['substitute_case_insensitive']) ? 'i' : '');
$pattern = '#'. strtr($val['substitute_from'], array('#' => '\#')) . '#' . $i;
foreach (array('title') as $property) {
$new = preg_replace($pattern, $val['substitute_to'], $node->{$property});
if ($new) {
$node->{$property} = $new;
}
}
foreach (array('body') as $property) {
foreach($node->{$property} as $lang => $row) {
foreach ($row as $delta => $data) {
foreach (array('value', 'summary') as $key) {
if (isset($node->{$property}[$lang][$delta][$key])) {
$new = preg_replace($pattern, $val['substitute_to'], $node->{$property}[$lang][$delta][$key]);
if ($new) {
$node->{$property}[$lang][$delta][$key] = $new;
}
}
}
}
}
}
}
// Let other modules do special fixing up.
$context = array('method' => 'action', 'original_node' => $original_node, 'clone_context' => $val);
backdrop_alter('clone_node', $node, $context);
node_save($node);
if (module_exists('rules')) {
rules_invoke_event('clone_node', $node, $original_node);
}
}
else {
backdrop_set_message(t('Clone failed for %title : not permitted for nodes of type %type', array('%title' => $original_node->title, '%type' => $original_node->type)), 'warning');
}
}
/**
* Action form.
*/
function clone_action_clone_form($context) {
$form['clone_context'] = array(
'#tree' => TRUE,
);
$form['clone_context']['prefix_title'] = array(
'#title' => t('Prefix title'),
'#type' => 'checkbox',
'#description' => t('Should cloned node tiles be prefixed?'),
'#default_value' => isset($context['clone_context']['prefix_title']) ? $context['clone_context']['prefix_title'] : 1,
);
$form['clone_context']['substitute_from'] = array(
'#title' => t('Substitute from string'),
'#type' => 'textfield',
'#description' => t('String (or regex) to substitute from in title and body.'),
'#default_value' => isset($context['clone_context']['substitue_from']) ? $context['clone_context']['substitue_from'] : '',
);
$form['clone_context']['substitute_to'] = array(
'#title' => t('Substitute to string'),
'#type' => 'textfield',
'#description' => t('String (or regex) to substitute to in title and body.'),
'#default_value' => isset($context['clone_context']['substitue_to']) ? $context['clone_context']['substitue_to'] : '',
);
$form['clone_context']['substitute_case_insensitive'] = array(
'#title' => t('Case insensitive substitution'),
'#type' => 'checkbox',
'#description' => t('Should the substituion match be case insensitive?'),
'#default_value' => isset($context['clone_context']['substitute_case_insensitive']) ? $context['clone_context']['substitute_case_insensitive'] : NULL,
);
return $form;
}
/**
* Action form submit.
*/
function clone_action_clone_submit($form, $form_state) {
return array('clone_context' => $form_state['values']['clone_context']);
}