Repository navigation
Expand file tree
/
Copy pathdwpage.php
More file actions
executable file
·378 lines (282 loc) · 9.28 KB
/
Copy pathdwpage.php
File metadata and controls
executable file
·378 lines (282 loc) · 9.28 KB
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<
8000
/div>
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
#!/usr/bin/php
<?php
#------------------------------------------------------------------------------
if ('cli' != php_sapi_name()) die();
ini_set('memory_limit','128M');
if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../').'/');
require_once DOKU_INC.'inc/init.php';
require_once DOKU_INC.'inc/common.php';
require_once DOKU_INC.'inc/cliopts.php';
#------------------------------------------------------------------------------
function usage($action) {
switch ( $action ) {
case 'checkout':
print "Usage: dwpage.php [opts] checkout <wiki:page> [working_file]
Checks out a file from the repository, using the wiki id and obtaining
a lock for the page.
If a working_file is specified, this is where the page is copied to.
Otherwise defaults to the same as the wiki page in the current
working directory.
EXAMPLE
$ ./dwpage.php checkout wiki:syntax ./new_syntax.txt
OPTIONS
-h, --help=<action>: get help
-f: force obtaining a lock for the page (generally bad idea)
";
break;
case 'commit':
print "Usage: dwpage.php [opts] -m \"Msg\" commit <working_file> <wiki:page>
Checks in the working_file into the repository using the specified
wiki id, archiving the previous version.
EXAMPLE
$ ./dwpage.php -m \"Some message\" commit ./new_syntax.txt wiki:syntax
OPTIONS
-h, --help=<action>: get help
-f: force obtaining a lock for the page (generally bad idea)
-t, trivial: minor change
-m (required): Summary message describing the change
";
break;
case 'lock':
print "Usage: dwpage.php [opts] lock <wiki:page>
Obtains or updates a lock for a wiki page
EXAMPLE
$ ./dwpage.php lock wiki:syntax
OPTIONS
-h, --help=<action>: get help
-f: force obtaining a lock for the page (generally bad idea)
";
break;
case 'unlock':
print "Usage: dwpage.php [opts] unlock <wiki:page>
Removes a lock for a wiki page.
EXAMPLE
$ ./dwpage.php unlock wiki:syntax
OPTIONS
-h, --help=<action>: get help
-f: force obtaining a lock for the page (generally bad idea)
";
break;
default:
print "Usage: dwpage.php [opts] <action>
Utility to help command line Dokuwiki page editing, allow
pages to be checked out for editing then committed after changes
Normal operation would be;
ACTIONS
checkout: see $ dwpage.php --help=checkout
commit: see $ dwpage.php --help=commit
lock: see $ d
8000
wpage.php --help=lock
OPTIONS
-h, --help=<action>: get help
e.g. $ ./dwpage.php -hcommit
e.g. $ ./dwpage.php --help=commit
";
break;
}
}
#------------------------------------------------------------------------------
function getUser() {
$user = getenv('USER');
if (empty ($user)) {
$user = getenv('USERNAME');
} else {
return $user;
}
if (empty ($user)) {
$user = 'admin';
}
return $user;
}
#------------------------------------------------------------------------------
function getSuppliedArgument($OPTS, $short, $long) {
$arg = $OPTS->get($short);
if ( is_null($arg) ) {
$arg = $OPTS->get($long);
}
return $arg;
}
#------------------------------------------------------------------------------
function obtainLock($WIKI_ID) {
global $USERNAME;
if ( !file_exists(wikiFN($WIKI_ID)) ) {
fwrite( STDERR, "$WIKI_ID does not yet exist\n");
}
$_SERVER['REMOTE_USER'] = $USERNAME;
if ( checklock($WIKI_ID) ) {
fwrite( STDERR, "Page $WIKI_ID is already locked by another user\n");
exit(1);
}
lock($WIKI_ID);
$_SERVER['REMOTE_USER'] = '_'.$USERNAME.'_';
if ( checklock($WIKI_ID) != $USERNAME ) {
fwrite( STDERR, "Unable to obtain lock for $WIKI_ID\n" );
exit(1);
}
}
#------------------------------------------------------------------------------
function clearLock($WIKI_ID) {
global $USERNAME ;
if ( !file_exists(wikiFN($WIKI_ID)) ) {
fwrite( STDERR, "$WIKI_ID does not yet exist\n");
}
$_SERVER['REMOTE_USER'] = $USERNAME;
if ( checklock($WIKI_ID) ) {
fwrite( STDERR, "Page $WIKI_ID is locked by another user\n");
exit(1);
}
unlock($WIKI_ID);
if ( file_exists(wikiLockFN($WIKI_ID)) ) {
fwrite( STDERR, "Unable to clear lock for $WIKI_ID\n" );
exit(1);
}
}
#------------------------------------------------------------------------------
function deleteLock($WIKI_ID) {
$wikiLockFN = wikiLockFN($WIKI_ID);
if ( file_exists($wikiLockFN) ) {
if ( !unlink($wikiLockFN) ) {
fwrite( STDERR, "Unable to delete $wikiLockFN\n" );
exit(1);
}
}
}
#------------------------------------------------------------------------------
$USERNAME = getUser();
$CWD = getcwd();
$SYSTEM_ID = '127.0.0.1';
#------------------------------------------------------------------------------
$OPTS = Doku_Cli_Opts::getOptions(
__FILE__,
'h::fm:u:s:t',
array(
'help==',
'user=',
'system=',
'trivial',
)
);
if ( $OPTS->isError() ) {
print $OPTS->getMessage()."\n";
exit(1);
}
if ( $OPTS->has('h') or $OPTS->has('help') or !$OPTS->hasArgs() ) {
usage(getSuppliedArgument($OPTS,'h','help'));
exit(0);
}
if ( $OPTS->has('u') or $OPTS->has('user') ) {
$USERNAME = getSuppliedArgument($OPTS,'u','user');
}
if ( $OPTS->has('s') or $OPTS->has('system') ) {
$SYSTEM_ID = getSuppliedArgument($OPTS,'s','system');
}
#------------------------------------------------------------------------------
switch ( $OPTS->arg(0) ) {
#----------------------------------------------------------------------
case 'checkout':
$WIKI_ID = $OPTS->arg(1);
if ( !$WIKI_ID ) {
fwrite( STDERR, "Wiki page ID required\n");
exit(1);
}
$WIKI_FN = wikiFN($WIKI_ID);
if ( !file_exists($WIKI_FN) ) {
fwrite( STDERR, "$WIKI_ID does not yet exist\n");
exit(1);
}
$TARGET_FN = $OPTS->arg(2);
if ( empty($TARGET_FN) ) {
$TARGET_FN = getcwd().'/'.utf8_basename($WIKI_FN);
}
if ( !file_exists(dirname($TARGET_FN)) ) {
fwrite( STDERR, "Directory ".dirname($TARGET_FN)." does not exist\n");
exit(1);
}
if ( stristr( realpath(dirname($TARGET_FN)), realpath($conf['datadir']) ) !== false ) {
fwrite( STDERR, "Attempt to check out file into data directory - not allowed\n");
exit(1);
}
if ( $OPTS->has('f') ) {
deleteLock($WIKI_ID);
}
obtainLock($WIKI_ID);
# Need to lock the file first?
if ( !copy($WIKI_FN, $TARGET_FN) ) {
fwrite( STDERR, "Unable to copy $WIKI_FN to $TARGET_FN\n");
clearLock($WIKI_ID);
exit(1);
}
print "$WIKI_ID > $TARGET_FN\n";
exit(0);
break;
#----------------------------------------------------------------------
case 'commit':
$TARGET_FN = $OPTS->arg(1);
if ( !$TARGET_FN ) {
fwrite( STDERR, "Target filename required\n");
exit(1);
}
if ( !file_exists($TARGET_FN) ) {
fwrite( STDERR, "$TARGET_FN does not exist\n");
exit(1);
}
if ( !is_readable($TARGET_FN) ) {
fwrite( STDERR, "Cannot read from $TARGET_FN\n");
exit(1);
}
$WIKI_ID = $OPTS->arg(2);
if ( !$WIKI_ID ) {
fwrite( STDERR, "Wiki page ID required\n");
exit(1);
}
if ( !$OPTS->has('m') ) {
fwrite( STDERR, "Summary message required\n");
exit(1);
}
if ( $OPTS->has('f') ) {
deleteLock($WIKI_ID);
}
$_SERVER['REMOTE_USER'] = $USERNAME;
if ( checklock($WIKI_ID) ) {
fwrite( STDERR, "$WIKI_ID is locked by another user\n");
exit(1);
}
obtainLock($WIKI_ID);
saveWikiText($WIKI_ID, file_get_contents($TARGET_FN), $OPTS->get('m'), $OPTS->has('t'));
clearLock($WIKI_ID);
exit(0);
break;
#----------------------------------------------------------------------
case 'lock':
$WIKI_ID = $OPTS->arg(1);
if ( !$WIKI_ID ) {
fwrite( STDERR, "Wiki page ID required\n");
exit(1);
}
if ( $OPTS->has('f') ) {
deleteLock($WIKI_ID);
}
obtainLock($WIKI_ID);
print "Locked : $WIKI_ID\n";
exit(0);
break;
#----------------------------------------------------------------------
case 'unlock':
$WIKI_ID = $OPTS->arg(1);
if ( !$WIKI_ID ) {
fwrite( STDERR, "Wiki page ID required\n");
exit(1);
}
if ( $OPTS->has('f') ) {
deleteLock($WIKI_ID);
} else {
clearLock($WIKI_ID);
}
print "Unlocked : $WIKI_ID\n";
exit(0);
break;
#----------------------------------------------------------------------
default:
fwrite( STDERR, "Invalid action ".$OPTS->arg(0)."\n" );
exit(1);
break;
}