-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathinstall_mod.php
213 lines (167 loc) · 6.4 KB
/
install_mod.php
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
<?php
/***********************************************************************/
// Some info about your mod.
$mod_title = 'Tapatalk';
$mod_version = '1.0';
$release_date = 'YYYY-MM-DD';
$author = 'XAOS Interactive';
$author_email = '[email protected]';
// Versions of FluxBB this mod was created for. A warning will be displayed, if versions do not match
$fluxbb_versions= array('1.5.7');
// Set this to false if you haven't implemented the restore function (see below)
$mod_restore = false;
// This following function will be called when the user presses the "Install" button
function install()
{
global $db, $db_type, $pun_config;
/*
DO MOD INSTALLATION HERE
Here's an example showing how to run different queries depending on $db_type
NOTE: This is just an example! Replace it with whatever queries your mod needs to run
Add column to existing table:
$allow_null = false;
$default_value = 0;
$after_field = 'some_existing_field';
$db->add_field('some_table', 'some_column', 'TINYINT(1) UNSIGNED', $allow_null, $default_value, $after_field) or error('Unable to add column "some_column" to table "some_table"', __FILE__, __LINE__, $db->error());
Create new table:
$schema = array(
'FIELDS' => array(
'id' => array(
'datatype' => 'SERIAL',
'allow_null' => false
),
'some_column' => array(
'datatype' => 'VARCHAR(200)',
'allow_null' => true
)
),
'PRIMARY KEY' => array('id'),
'INDEXES' => array(
'some_column_idx' => array('some_column')
)
);
$db->create_table('new_table_name', $schema) or error('Unable to create table "new_table_name"', __FILE__, __LINE__, $db->error());
*/
$tapatalk_users = array(
'FIELDS' => array(
'userid' => array(
'allow_null' => false
),
'announcement' => array(
),
),
);
$tapatalk_push_data = array (
'FIELDS' => array (
'push_id' => array(
),
),
);
$db->create_table('tapatalk_users', $tapatalk_users) or error('Unable to create table "tapatalk_users"', __FILE__, __LINE__, $db->error());
$db->create_table('tapatalk_push_data', $tapatalk_push_data) or error('Unable to create table "tapatalk_push_data"', __FILE__, __LINE__, $db->error());
}
// This following function will be called when the user presses the "Restore" button (only if $mod_restore is true (see above))
function restore()
{
global $db, $db_type, $pun_config;
/*
DO DATABASE RESTORE HERE
Drop column:
$db->drop_field('some_table', 'some_column') or error('Unable to drop column "some_column" from table "some_table"', __FILE__, __LINE__, $db->error());
Drop table:
$db->drop_table('new_table_name') or error('Unable to drop table "new_table_name"', __FILE__, __LINE__, $db->error());
*/
}
/***********************************************************************/
// DO NOT EDIT ANYTHING BELOW THIS LINE!
// Circumvent maintenance mode
define('PUN_TURN_OFF_MAINT', 1);
define('PUN_ROOT', './');
require PUN_ROOT.'include/common.php';
// We want the complete error message if the script fails
if (!defined('PUN_DEBUG'))
define('PUN_DEBUG', 1);
// Make sure we are running a FluxBB version that this mod works with
$version_warning = !in_array($pun_config['o_cur_version'], $fluxbb_versions);
$style = (isset($pun_user)) ? $pun_user['style'] : $pun_config['o_default_style'];
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title><?php echo pun_htmlspecialchars($mod_title) ?> installation</title>
<link rel="stylesheet" type="text/css" href="style/<?php echo $style.'.css' ?>" />
</head>
<body>
<div id="punwrap">
<div id="puninstall" class="pun" style="margin: 10% 20% auto 20%">
<?php
if (isset($_POST['form_sent']))
{
if (isset($_POST['install']))
{
// Run the install function (defined above)
install();
?>
<div class="block">
<h2><span>Installation successful</span></h2>
<div class="box">
<div class="inbox">
<p>Your database has been successfully prepared for <?php echo pun_htmlspecialchars($mod_title) ?>. See readme.txt for further instructions.</p>
</div>
</div>
</div>
<?php
}
else
{
// Run the restore function (defined above)
restore();
?>
<div class="block">
<h2><span>Restore successful</span></h2>
<div class="box">
<div class="inbox">
<p>Your database has been successfully restored.</p>
</div>
</div>
</div>
<?php
}
}
else
{
?>
<div class="blockform">
<h2><span>Mod installation</span></h2>
<div class="box">
<form method="post" action="<?php echo $_SERVER['PHP_SELF'] ?>?foo=bar">
<div><input type="hidden" name="form_sent" value="1" /></div>
<div class="inform">
<p>This script will update your database to work with the following modification:</p>
<p><strong>Mod title:</strong> <?php echo pun_htmlspecialchars($mod_title.' '.$mod_version) ?></p>
<p><strong>Author:</strong> <?php echo pun_htmlspecialchars($author) ?> (<a href="mailto:<?php echo pun_htmlspecialchars($author_email) ?>"><?php echo pun_htmlspecialchars($author_email) ?></a>)</p>
<p><strong>Disclaimer:</strong> Mods are not officially supported by FluxBB. Mods generally can't be uninstalled without running SQL queries manually against the database. Make backups of all data you deem necessary before installing.</p>
<?php if ($mod_restore): ?>
<p>If you've previously installed this mod and would like to uninstall it, you can click the Restore button below to restore the database.</p>
<?php endif; ?>
<?php if ($version_warning): ?>
<p style="color: #a00"><strong>Warning:</strong> The mod you are about to install was not made specifically to support your current version of FluxBB (<?php echo $pun_config['o_cur_version']; ?>). This mod supports FluxBB versions: <?php echo pun_htmlspecialchars(implode(', ', $fluxbb_versions)); ?>. If you are uncertain about installing the mod due to this potential version conflict, contact the mod author.</p>
<?php endif; ?>
</div>
<p class="buttons"><input type="submit" name="install" value="Install" /><?php if ($mod_restore): ?><input type="submit" name="restore" value="Restore" /><?php endif; ?></p>
</form>
</div>
</div>
<?php
}
?>
</div>
</div>
</body>
</html>
<?php
// End the transaction
$db->end_transaction();
// Close the db connection (and free up any result data)
$db->close();