@teresa-hale/nodebb-plugin-import-phpbb
Version:
A phpBB2 to NodeBB data exporter
413 lines (350 loc) • 14 kB
JavaScript
var async = require('async');
var mysql = require('mysql');
var _ = require('underscore');
var noop = function(){};
var logPrefix = '[nodebb-plugin-import-phpbb]';
(function(Exporter) {
Exporter.setup = function(config, callback) {
Exporter.log('setup');
// mysql db only config
// extract them from the configs passed by the nodebb-plugin-import adapter
var _config = {
host: config.dbhost || config.host || 'localhost',
user: config.dbuser || config.user || 'root',
password: config.dbpass || config.pass || config.password || '',
port: config.dbport || config.port || 3306,
database: config.dbname || config.name || config.database || 'phpbb'
};
Exporter.config(_config);
Exporter.config('prefix', config.prefix || config.tablePrefix || '' /* phpbb_ ? */ );
Exporter.connection = mysql.createConnection(_config);
Exporter.connection.connect();
callback(null, Exporter.config());
};
Exporter.getUsers = function(callback) {
return Exporter.getPaginatedUsers(0, -1, callback);
};
Exporter.getPaginatedUsers = function(start, limit, callback) {
callback = !_.isFunction(callback) ? noop : callback;
var err;
var prefix = Exporter.config('prefix');
var startms = +new Date();
var query = 'SELECT '
+ prefix + 'users.user_id as _uid, '
+ prefix + 'users.username as _username, '
+ prefix + 'users.email as _registrationEmail, '
//+ prefix + 'users.user_rank as _level, '
+ prefix + 'users.date as _joindate, '
+ prefix + 'users.email as _email, '
+ prefix + 'users.banned as _banned, '
+ prefix + 'users.USER_SIG as _signature, '
+ prefix + 'users.USER_website as _website, '
+ prefix + 'users.USER_OCC as _occupation, '
+ prefix + 'users.USER_FROM as _location, '
+ prefix + 'users.USER_AVATAR as _picture, '
//+ prefix + 'USER_PROFILE.USER_TITLE as _title, '
//+ prefix + 'USER_PROFILE.USER_RATING as _reputation, '
+ prefix + 'users.HITCOUNT as _profileviews '
//+ prefix + 'USER_PROFILE.USER_BIRTHDAY as _birthday '
+ 'FROM ' + prefix + 'users '
+ 'WHERE ' + prefix + 'users.user_id = ' + prefix + 'users.user_id '
+ (start >= 0 && limit >= 0 ? 'LIMIT ' + start + ',' + limit : '');
if (!Exporter.connection) {
err = {error: 'MySQL connection is not setup. Run setup(config) first'};
Exporter.error(err.error);
return callback(err);
}
Exporter.connection.query(query,
function(err, rows) {
if (err) {
Exporter.error(err);
return callback(err);
}
//normalize here
var map = {};
rows.forEach(function(row) {
// nbb forces signatures to be less than 150 chars
// keeping it HTML see https://github.com/akhoury/nodebb-plugin-import#markdown-note
row._signature = Exporter.truncateStr(row._signature || '', 150);
// from unix timestamp (s) to JS timestamp (ms)
row._joindate = ((row._joindate || 0) * 1000) || startms;
// lower case the email for consistency
row._email = (row._email || '').toLowerCase();
// I don't know about you about I noticed a lot my users have incomplete urls, urls like: http://
row._picture = Exporter.validateUrl(row._picture);
row._website = Exporter.validateUrl(row._website);
map[row._uid] = row;
});
callback(null, map);
});
};
Exporter.getMessages = function(callback) {
return Exporter.getPaginatedMessages_(0, -1, callback);
}
Exporter.getPaginatedMessages_ = function(start, limit, callback) {
callback = !_.isFunction(callback) ? noop : callback;
var err;
var prefix = Exporter.config('prefix');
var startms = +new Date();
var query = `SELECT * FROM (SELECT ${prefix}privmsgs.privmsgs_id as _mid, ${prefix}privmsgs.from_user_id as _fromuid, ${prefix}privmsgs.privmsgs_date as _timestamp, ${prefix}privmsgs.privmsgs_to_userid as _touid, FROM ${prefix}privmsgs) as a JOIN ${prefix}privmsgs_text ON a._mid = ${prefix}privmsgs_text.privmsgs_text_id`;
if (!Exporter.connection) {
err = {error: 'MySQL connection is not setup. Run setup(config) first'};
Exporter.error(err.error);
return callback(err);
}
Exporter.connection.query(query,
function (err, rows) {
if (err) {
Exporter.error(err);
return callback(err);
}
getTopicsMainPids(function(err, mpids) {
//normalize here
var map = {};
rows.forEach(function (row) {
if (! mpids[row._pid]) {
row._content = row._content || '';
row._timestamp = ((row._timestamp || 0) * 1000) || startms;
map[row._mid] = row;
}
});
callback(null, map);
});
});
};
Exporter.getCategories = function(callback) {
return Exporter.getPaginatedCategories(0, -1, callback);
};
Exporter.getPaginatedCategories = function(start, limit, callback) {
callback = !_.isFunction(callback) ? noop : callback;
var err;
var prefix = Exporter.config('prefix');
var startms = +new Date();
var query = 'SELECT '
+ prefix + 'forums.forum_id as _cid, '
+ prefix + 'forums.forum_name as _name, '
+ prefix + 'forums.forum_desc as _description '
+ 'FROM ' + prefix + 'forums '
+ (start >= 0 && limit >= 0 ? 'LIMIT ' + start + ',' + limit : '');
if (!Exporter.connection) {
err = {error: 'MySQL connection is not setup. Run setup(config) first'};
Exporter.error(err.error);
return callback(err);
}
Exporter.connection.query(query,
function(err, rows) {
if (err) {
Exporter.error(err);
return callback(err);
}
//normalize here
var map = {};
rows.forEach(function(row) {
row._name = row._name || 'Untitled Category';
row._description = row._description || 'No decsciption available';
row._timestamp = ((row._timestamp || 0) * 1000) || startms;
map[row._cid] = row;
});
callback(null, map);
});
};
Exporter.getTopics = function(callback) {
return Exporter.getPaginatedTopicss(0, -1, callback);
};
Exporter.getPaginatedTopicss = function(start, limit, callback) {
callback = !_.isFunction(callback) ? noop : callback;
var err;
var prefix = Exporter.config('prefix');
var startms = +new Date();
var query = `SELECT * FROM ( SELECT ${prefix}topics.topic_id AS _tid, ${prefix}topics.forum_id AS _cid, ${prefix}topics.topic_first_post_id AS _pid, ${prefix}topics.topic_views AS _viewcount, ${prefix}topics.topic_title AS _title, ${prefix}topics.topic_time AS _timestamp, ${prefix}topics.topic_status AS _status FROM ${prefix}topics ) AS a JOIN( SELECT ${prefix}posts.post_id AS pidd, ${prefix}posts.poster_id AS _uid, ${prefix}posts.topic_id AS _post_tid FROM ${prefix}posts ) AS b ON b.pidd = a._pid JOIN( SELECT ${prefix}posts_text.post_text AS _content, ${prefix}posts_text.post_id AS p1d FROM ${prefix}posts_text ) AS cd ON a._pid = cd.p1d`
/* var query =
'SELECT '
+ prefix + 'topics.topic_id as _tid, '
+ prefix + 'topics.forum_id as _cid, '
// this is the 'parent-post'
// see https://github.com/akhoury/nodebb-plugin-import#important-note-on-topics-and-posts
// I don't really need it since I just do a simple join and get its content, but I will include for the reference
// remember this post EXCLUDED in the exportPosts() function
+ prefix + 'topics.topic_first_post_id as _pid, '
+ prefix + 'topics.topic_views as _viewcount, '
+ prefix + 'topics.topic_title as _title, '
+ prefix + 'topics.topic_time as _timestamp, '
+ prefix + 'topics.topic_status as _status, '
//+ prefix + 'TOPICS.TOPIC_IS_STICKY as _pinned, '
+ prefix + 'posts.poster_id as _uid, '
// this should be == to the _tid on top of this query
+ prefix + 'posts.topic_id as _post_tid, '
// and there is the content I need !!
+ prefix + 'posts_text.post_text as _content '
+ 'FROM ' + prefix + 'topics, ' + prefix + 'posts, ' + prefix + 'posts_text'
// see
+ ' WHERE ' + prefix + 'topics.topic_first_post_id=' + prefix + 'posts.post_id ' */
//console.log(query)
if (!Exporter.connection) {
err = {error: 'MySQL connection is not setup. Run setup(config) first'};
Exporter.error(err.error);
return callback(err);
}
Exporter.connection.query(query,
function(err, rows) {
if (err) {
Exporter.error(err);
return callback(err);
}
//normalize here
var map = {};
console.log(rows.length)
rows.forEach(function(row) {
row._title = row._title ? row._title[0].toUpperCase() + row._title.substr(1) : 'Untitled';
row._timestamp = ((row._timestamp || 0) * 1000) || startms;
map[row._tid] = row;
});
callback(null, map);
});
};
var getTopicsMainPids = function(callback) {
if (Exporter._topicsMainPids) {
return callback(null, Exporter._topicsMainPids);
}
Exporter.getPaginatedTopicss(0, -1, function(err, topicsMap) {
if (err) return callback(err);
Exporter._topicsMainPids = {};
Object.keys(topicsMap).forEach(function(_tid) {
var topic = topicsMap[_tid];
Exporter._topicsMainPids[topic.topic_first_post_id] = topic._tid;
});
callback(null, Exporter._topicsMainPids);
});
};
Exporter.getPosts = function(callback) {
return Exporter._getPaginatedPosts(0, -1, callback);
};
Exporter._getPaginatedPosts = function(start, limit, callback) {
callback = !_.isFunction(callback) ? noop : callback;
var err;
var prefix = Exporter.config('prefix');
var startms = +new Date();
var query = `SELECT * FROM (SELECT ${prefix}posts.post_id as _pid, ${prefix}posts.topic_id as _tid, ${prefix}posts.post_time as _timestamp, ${prefix}posts.poster_id as _uid FROM ${prefix}posts) as a JOIN (SELECT ${prefix}posts_text.post_text as _content, ${prefix}posts_text.post_id as piddy FROM ${prefix}posts_text) as b ON b.piddy = a._pid`;
if (!Exporter.connection) {
err = {error: 'MySQL connection is not setup. Run setup(config) first'};
Exporter.error(err.error);
return callback(err);
}
Exporter.connection.query(query,
function (err, rows) {
if (err) {
Exporter.error(err);
return callback(err);
}
getTopicsMainPids(function(err, mpids) {
//normalize here
var map = {};
rows.forEach(function (row) {
// make it's not a topic
if (! mpids[row._pid]) {
row._content = row._content || '';
row._timestamp = ((row._timestamp || 0) * 1000) || startms;
map[row._pid] = row;
}
});
callback(null, map);
});
});
};
Exporter.teardown = function(callback) {
Exporter.log('teardown');
Exporter.connection.end();
Exporter.log('Done');
callback();
};
Exporter.testrun = function(config, callback) {
async.series([
function(next) {
Exporter.setup(config, next);
},
function(next) {
Exporter.getUsers(next);
},
function(next) {
Exporter.getCategories(next);
},
function(next) {
Exporter.getTopics(next);
},
function(next) {
Exporter.getPosts(next);
},
function(next) {
Exporter.teardown(next);
}
], callback);
};
Exporter.paginatedTestrun = function(config, callback) {
async.series([
function(next) {
Exporter.setup(config, next);
},
function(next) {
Exporter.getPaginatedUsers(0, 1000, next);
},
function(next) {
Exporter.getPaginatedCategories(0, 1000, next);
},
function(next) {
Exporter.getPaginatedTopics(0, 1000, next);
},
function(next) {
Exporter._getPaginatedPosts(1001, 2000, next);
},
function(next) {
Exporter.teardown(next);
}
], callback);
};
Exporter.warn = function() {
var args = _.toArray(arguments);
args.unshift(logPrefix);
console.warn.apply(console, args);
};
Exporter.log = function() {
var args = _.toArray(arguments);
args.unshift(logPrefix);
console.log.apply(console, args);
};
Exporter.error = function() {
var args = _.toArray(arguments);
args.unshift(logPrefix);
console.error.apply(console, args);
};
Exporter.config = function(config, val) {
if (config != null) {
if (typeof config === 'object') {
Exporter._config = config;
} else if (typeof config === 'string') {
if (val != null) {
Exporter._config = Exporter._config || {};
Exporter._config[config] = val;
}
return Exporter._config[config];
}
}
return Exporter._config;
};
// from Angular https://github.com/angular/angular.js/blob/master/src/ng/directive/input.js#L11
Exporter.validateUrl = function(url) {
var pattern = /^(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?$/;
return url && url.length < 2083 && url.match(pattern) ? url : '';
};
Exporter.truncateStr = function(str, len) {
if (typeof str != 'string') return str;
len = _.isNumber(len) && len > 3 ? len : 20;
return str.length <= len ? str : str.substr(0, len - 3) + '...';
};
Exporter.whichIsFalsy = function(arr) {
for (var i = 0; i < arr.length; i++) {
if (!arr[i])
return i;
}
return null;
};
})(module.exports);