14f65771d694e3873fe762a8c35c186bfcee3e8e
1# Copyright (C) 2012
2# Charles Roussel <charles.roussel@ensimag.imag.fr>
3# Simon Cathebras <simon.cathebras@ensimag.imag.fr>
4# Julien Khayat <julien.khayat@ensimag.imag.fr>
5# Guillaume Sasdy <guillaume.sasdy@ensimag.imag.fr>
6# Simon Perrat <simon.perrat@ensimag.imag.fr>
7# License: GPL v2 or later
8
9#
10# CONFIGURATION VARIABLES
11# You might want to change these ones
12#
13
14. ./test.config
15
16WIKI_URL=http://"$SERVER_ADDR:$PORT/$WIKI_DIR_NAME"
17CURR_DIR=$(pwd)
18TEST_OUTPUT_DIRECTORY=$(pwd)
19TEST_DIRECTORY="$CURR_DIR"/../../../t
20
21export TEST_OUTPUT_DIRECTORY TEST_DIRECTORY CURR_DIR
22
23if test "$LIGHTTPD" = "false" ; then
24 PORT=80
25else
26 WIKI_DIR_INST="$CURR_DIR/$WEB_WWW"
27fi
28
29
30wiki_getpage () {
31 "$CURR_DIR"/test-gitmw.pl get_page "$@"
32}
33
34wiki_delete_page () {
35 "$CURR_DIR"/test-gitmw.pl delete_page "$@"
36}
37
38wiki_editpage () {
39 "$CURR_DIR"/test-gitmw.pl edit_page "$@"
40}
41
42die () {
43 die_with_status 1 "$@"
44}
45
46die_with_status () {
47 status=$1
48 shift
49 echo >&2 "$*"
50 exit "$status"
51}
52
53
54# Check the preconditions to run git-remote-mediawiki's tests
55test_check_precond () {
56 if ! test_have_prereq PERL
57 then
58 skip_all='skipping gateway git-mw tests, perl not available'
59 test_done
60 fi
61
62 if [ ! -f "$GIT_BUILD_DIR"/git-remote-mediawiki ];
63 then
64 echo "No remote mediawiki for git found. Copying it in git"
65 echo "cp $GIT_BUILD_DIR/contrib/mw-to-git/git-remote-mediawiki $GIT_BUILD_DIR/"
66 ln -s "$GIT_BUILD_DIR"/contrib/mw-to-git/git-remote-mediawiki "$GIT_BUILD_DIR"
67 fi
68
69 if [ ! -d "$WIKI_DIR_INST/$WIKI_DIR_NAME" ];
70 then
71 skip_all='skipping gateway git-mw tests, no mediawiki found'
72 test_done
73 fi
74}
75
76# test_diff_directories <dir_git> <dir_wiki>
77#
78# Compare the contents of directories <dir_git> and <dir_wiki> with diff
79# and errors if they do not match. The program will
80# not look into .git in the process.
81# Warning: the first argument MUST be the directory containing the git data
82test_diff_directories () {
83 rm -rf "$1_tmp"
84 mkdir -p "$1_tmp"
85 cp "$1"/*.mw "$1_tmp"
86 diff -r -b "$1_tmp" "$2"
87}
88
89# $1=<dir>
90# $2=<N>
91#
92# Check that <dir> contains exactly <N> files
93test_contains_N_files () {
94 if test `ls -- "$1" | wc -l` -ne "$2"; then
95 echo "directory $1 sould contain $2 files"
96 echo "it contains these files:"
97 ls "$1"
98 false
99 fi
100}
101
102
103# wiki_check_content <file_name> <page_name>
104#
105# Compares the contents of the file <file_name> and the wiki page
106# <page_name> and exits with error 1 if they do not match.
107wiki_check_content () {
108 mkdir -p wiki_tmp
109 wiki_getpage "$2" wiki_tmp
110 # replacement of forbidden character in file name
111 page_name=$(printf "%s\n" "$2" | sed -e "s/\//%2F/g")
112
113 diff -b "$1" wiki_tmp/"$page_name".mw
114 if test $? -ne 0
115 then
116 rm -rf wiki_tmp
117 error "ERROR: file $2 not found on wiki"
118 fi
119 rm -rf wiki_tmp
120}
121
122# wiki_page_exist <page_name>
123#
124# Check the existence of the page <page_name> on the wiki and exits
125# with error if it is absent from it.
126wiki_page_exist () {
127 mkdir -p wiki_tmp
128 wiki_getpage "$1" wiki_tmp
129 page_name=$(printf "%s\n" "$1" | sed "s/\//%2F/g")
130 if test -f wiki_tmp/"$page_name".mw ; then
131 rm -rf wiki_tmp
132 else
133 rm -rf wiki_tmp
134 error "test failed: file $1 not found on wiki"
135 fi
136}
137
138# wiki_getallpagename
139#
140# Fetch the name of each page on the wiki.
141wiki_getallpagename () {
142 "$CURR_DIR"/test-gitmw.pl getallpagename
143}
144
145# wiki_getallpagecategory <category>
146#
147# Fetch the name of each page belonging to <category> on the wiki.
148wiki_getallpagecategory () {
149 "$CURR_DIR"/test-gitmw.pl getallpagename "$@"
150}
151
152# wiki_getallpage <dest_dir> [<category>]
153#
154# Fetch all the pages from the wiki and place them in the directory
155# <dest_dir>.
156# If <category> is define, then wiki_getallpage fetch the pages included
157# in <category>.
158wiki_getallpage () {
159 if test -z "$2";
160 then
161 wiki_getallpagename
162 else
163 wiki_getallpagecategory "$2"
164 fi
165 mkdir -p "$1"
166 while read -r line; do
167 wiki_getpage "$line" $1;
168 done < all.txt
169}
170
171# ================= Install part =================
172
173error () {
174 echo "$@" >&2
175 exit 1
176}
177
178# config_lighttpd
179#
180# Create the configuration files and the folders necessary to start lighttpd.
181# Overwrite any existing file.
182config_lighttpd () {
183 mkdir -p $WEB
184 mkdir -p $WEB_TMP
185 mkdir -p $WEB_WWW
186 cat > $WEB/lighttpd.conf <<EOF
187 server.document-root = "$CURR_DIR/$WEB_WWW"
188 server.port = $PORT
189 server.pid-file = "$CURR_DIR/$WEB_TMP/pid"
190
191 server.modules = (
192 "mod_rewrite",
193 "mod_redirect",
194 "mod_access",
195 "mod_accesslog",
196 "mod_fastcgi"
197 )
198
199 index-file.names = ("index.php" , "index.html")
200
201 mimetype.assign = (
202 ".pdf" => "application/pdf",
203 ".sig" => "application/pgp-signature",
204 ".spl" => "application/futuresplash",
205 ".class" => "application/octet-stream",
206 ".ps" => "application/postscript",
207 ".torrent" => "application/x-bittorrent",
208 ".dvi" => "application/x-dvi",
209 ".gz" => "application/x-gzip",
210 ".pac" => "application/x-ns-proxy-autoconfig",
211 ".swf" => "application/x-shockwave-flash",
212 ".tar.gz" => "application/x-tgz",
213 ".tgz" => "application/x-tgz",
214 ".tar" => "application/x-tar",
215 ".zip" => "application/zip",
216 ".mp3" => "audio/mpeg",
217 ".m3u" => "audio/x-mpegurl",
218 ".wma" => "audio/x-ms-wma",
219 ".wax" => "audio/x-ms-wax",
220 ".ogg" => "application/ogg",
221 ".wav" => "audio/x-wav",
222 ".gif" => "image/gif",
223 ".jpg" => "image/jpeg",
224 ".jpeg" => "image/jpeg",
225 ".png" => "image/png",
226 ".xbm" => "image/x-xbitmap",
227 ".xpm" => "image/x-xpixmap",
228 ".xwd" => "image/x-xwindowdump",
229 ".css" => "text/css",
230 ".html" => "text/html",
231 ".htm" => "text/html",
232 ".js" => "text/javascript",
233 ".asc" => "text/plain",
234 ".c" => "text/plain",
235 ".cpp" => "text/plain",
236 ".log" => "text/plain",
237 ".conf" => "text/plain",
238 ".text" => "text/plain",
239 ".txt" => "text/plain",
240 ".dtd" => "text/xml",
241 ".xml" => "text/xml",
242 ".mpeg" => "video/mpeg",
243 ".mpg" => "video/mpeg",
244 ".mov" => "video/quicktime",
245 ".qt" => "video/quicktime",
246 ".avi" => "video/x-msvideo",
247 ".asf" => "video/x-ms-asf",
248 ".asx" => "video/x-ms-asf",
249 ".wmv" => "video/x-ms-wmv",
250 ".bz2" => "application/x-bzip",
251 ".tbz" => "application/x-bzip-compressed-tar",
252 ".tar.bz2" => "application/x-bzip-compressed-tar",
253 "" => "text/plain"
254 )
255
256 fastcgi.server = ( ".php" =>
257 ("localhost" =>
258 ( "socket" => "$CURR_DIR/$WEB_TMP/php.socket",
259 "bin-path" => "$PHP_DIR/php-cgi -c $CURR_DIR/$WEB/php.ini"
260
261 )
262 )
263 )
264EOF
265
266 cat > $WEB/php.ini <<EOF
267 session.save_path ='$CURR_DIR/$WEB_TMP'
268EOF
269}
270
271# start_lighttpd
272#
273# Start or restart daemon lighttpd. If restart, rewrite configuration files.
274start_lighttpd () {
275 if test -f "$WEB_TMP/pid"; then
276 echo "Instance already running. Restarting..."
277 stop_lighttpd
278 fi
279 config_lighttpd
280 "$LIGHTTPD_DIR"/lighttpd -f "$WEB"/lighttpd.conf
281
282 if test $? -ne 0 ; then
283 echo "Could not execute http deamon lighttpd"
284 exit 1
285 fi
286}
287
288# stop_lighttpd
289#
290# Kill daemon lighttpd and removes files and folders associated.
291stop_lighttpd () {
292 test -f "$WEB_TMP/pid" && kill $(cat "$WEB_TMP/pid")
293 rm -rf "$WEB"
294}
295
296# Create the SQLite database of the MediaWiki. If the database file already
297# exists, it will be deleted.
298# This script should be runned from the directory where $FILES_FOLDER is
299# located.
300create_db () {
301 rm -f "$TMP/$DB_FILE"
302
303 echo "Generating the SQLite database file. It can take some time ..."
304 # Run the php script to generate the SQLite database file
305 # with cURL calls.
306 php "$FILES_FOLDER/$DB_INSTALL_SCRIPT" $(basename "$DB_FILE" .sqlite) \
307 "$WIKI_ADMIN" "$WIKI_PASSW" "$TMP" "$PORT"
308
309 if [ ! -f "$TMP/$DB_FILE" ] ; then
310 error "Can't create database file $TMP/$DB_FILE. Try to run ./install-wiki.sh delete first."
311 fi
312
313 # Copy the generated database file into the directory the
314 # user indicated.
315 cp "$TMP/$DB_FILE" "$FILES_FOLDER" ||
316 error "Unable to copy $TMP/$DB_FILE to $FILES_FOLDER"
317}
318
319# Install a wiki in your web server directory.
320wiki_install () {
321 if test $LIGHTTPD = "true" ; then
322 start_lighttpd
323 fi
324
325 SERVER_ADDR=$SERVER_ADDR:$PORT
326 # In this part, we change directory to $TMP in order to download,
327 # unpack and copy the files of MediaWiki
328 (
329 mkdir -p "$WIKI_DIR_INST/$WIKI_DIR_NAME"
330 if [ ! -d "$WIKI_DIR_INST/$WIKI_DIR_NAME" ] ; then
331 error "Folder $WIKI_DIR_INST/$WIKI_DIR_NAME doesn't exist.
332 Please create it and launch the script again."
333 fi
334
335 # Fetch MediaWiki's archive if not already present in the TMP directory
336 cd "$TMP"
337 if [ ! -f "$MW_VERSION.tar.gz" ] ; then
338 echo "Downloading $MW_VERSION sources ..."
339 wget "http://download.wikimedia.org/mediawiki/1.19/mediawiki-1.19.0.tar.gz" ||
340 error "Unable to download "\
341 "http://download.wikimedia.org/mediawiki/1.19/"\
342 "mediawiki-1.19.0.tar.gz. "\
343 "Please fix your connection and launch the script again."
344 echo "$MW_VERSION.tar.gz downloaded in `pwd`. "\
345 "You can delete it later if you want."
346 else
347 echo "Reusing existing $MW_VERSION.tar.gz downloaded in `pwd`."
348 fi
349 archive_abs_path=$(pwd)/"$MW_VERSION.tar.gz"
350 cd "$WIKI_DIR_INST/$WIKI_DIR_NAME/" ||
351 error "can't cd to $WIKI_DIR_INST/$WIKI_DIR_NAME/"
352 tar xzf "$archive_abs_path" --strip-components=1 ||
353 error "Unable to extract WikiMedia's files from $archive_abs_path to "\
354 "$WIKI_DIR_INST/$WIKI_DIR_NAME"
355 ) || exit 1
356
357 create_db
358
359 # Copy the generic LocalSettings.php in the web server's directory
360 # And modify parameters according to the ones set at the top
361 # of this script.
362 # Note that LocalSettings.php is never modified.
363 if [ ! -f "$FILES_FOLDER/LocalSettings.php" ] ; then
364 error "Can't find $FILES_FOLDER/LocalSettings.php " \
365 "in the current folder. "\
366 "Please run the script inside its folder."
367 fi
368 cp "$FILES_FOLDER/LocalSettings.php" \
369 "$FILES_FOLDER/LocalSettings-tmp.php" ||
370 error "Unable to copy $FILES_FOLDER/LocalSettings.php " \
371 "to $FILES_FOLDER/LocalSettings-tmp.php"
372
373 # Parse and set the LocalSettings file of the user according to the
374 # CONFIGURATION VARIABLES section at the beginning of this script
375 file_swap="$FILES_FOLDER/LocalSettings-swap.php"
376 sed "s,@WG_SCRIPT_PATH@,/$WIKI_DIR_NAME," \
377 "$FILES_FOLDER/LocalSettings-tmp.php" > "$file_swap"
378 mv "$file_swap" "$FILES_FOLDER/LocalSettings-tmp.php"
379 sed "s,@WG_SERVER@,http://$SERVER_ADDR," \
380 "$FILES_FOLDER/LocalSettings-tmp.php" > "$file_swap"
381 mv "$file_swap" "$FILES_FOLDER/LocalSettings-tmp.php"
382 sed "s,@WG_SQLITE_DATADIR@,$TMP," \
383 "$FILES_FOLDER/LocalSettings-tmp.php" > "$file_swap"
384 mv "$file_swap" "$FILES_FOLDER/LocalSettings-tmp.php"
385 sed "s,@WG_SQLITE_DATAFILE@,$( basename $DB_FILE .sqlite)," \
386 "$FILES_FOLDER/LocalSettings-tmp.php" > "$file_swap"
387 mv "$file_swap" "$FILES_FOLDER/LocalSettings-tmp.php"
388
389 mv "$FILES_FOLDER/LocalSettings-tmp.php" \
390 "$WIKI_DIR_INST/$WIKI_DIR_NAME/LocalSettings.php" ||
391 error "Unable to move $FILES_FOLDER/LocalSettings-tmp.php" \
392 "in $WIKI_DIR_INST/$WIKI_DIR_NAME"
393 echo "File $FILES_FOLDER/LocalSettings.php is set in" \
394 " $WIKI_DIR_INST/$WIKI_DIR_NAME"
395
396 echo "Your wiki has been installed. You can check it at
397 http://$SERVER_ADDR/$WIKI_DIR_NAME"
398}
399
400# Reset the database of the wiki and the password of the admin
401#
402# Warning: This function must be called only in a subdirectory of t/ directory
403wiki_reset () {
404 # Copy initial database of the wiki
405 if [ ! -f "../$FILES_FOLDER/$DB_FILE" ] ; then
406 error "Can't find ../$FILES_FOLDER/$DB_FILE in the current folder."
407 fi
408 cp "../$FILES_FOLDER/$DB_FILE" "$TMP" ||
409 error "Can't copy ../$FILES_FOLDER/$DB_FILE in $TMP"
410 echo "File $FILES_FOLDER/$DB_FILE is set in $TMP"
411}
412
413# Delete the wiki created in the web server's directory and all its content
414# saved in the database.
415wiki_delete () {
416 if test $LIGHTTPD = "true"; then
417 stop_lighttpd
418 else
419 # Delete the wiki's directory.
420 rm -rf "$WIKI_DIR_INST/$WIKI_DIR_NAME" ||
421 error "Wiki's directory $WIKI_DIR_INST/" \
422 "$WIKI_DIR_NAME could not be deleted"
423 # Delete the wiki's SQLite database.
424 rm -f "$TMP/$DB_FILE" ||
425 error "Database $TMP/$DB_FILE could not be deleted."
426 fi
427
428 # Delete the wiki's SQLite database
429 rm -f "$TMP/$DB_FILE" || error "Database $TMP/$DB_FILE could not be deleted."
430 rm -f "$FILES_FOLDER/$DB_FILE"
431 rm -rf "$TMP/$MW_VERSION"
432}