overview.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. const {MessageEmbed} = require('discord.js');
  2. const logging = require('../../util/logging.js');
  3. const {timeoptions} = require('../../util/default.json');
  4. const {got, toFormatting, toPlaintext, escapeFormatting} = require('../../util/functions.js');
  5. /**
  6. * Sends a Gamepedia wiki overview.
  7. * @param {import('../../util/i18n.js')} lang - The user language.
  8. * @param {import('discord.js').Message} msg - The Discord message.
  9. * @param {import('../../util/wiki.js')} wiki - The wiki for the overview.
  10. * @param {import('discord.js').MessageReaction} reaction - The reaction on the message.
  11. * @param {String} spoiler - If the response is in a spoiler.
  12. * @param {Boolean} noEmbed - If the response should be without an embed.
  13. * @param {URLSearchParams} [querystring] - The querystring for the link.
  14. * @param {String} [fragment] - The section for the link.
  15. */
  16. function gamepedia_overview(lang, msg, wiki, reaction, spoiler, noEmbed, querystring = new URLSearchParams(), fragment = '') {
  17. var uselang = ( querystring.getAll('variant').pop() || querystring.getAll('uselang').pop() || lang.lang );
  18. got.get( wiki + 'api.php?uselang=' + uselang + '&action=query&meta=allmessages|siteinfo&amenableparser=true&amtitle=Special:Statistics&ammessages=statistics' + ( wiki.isFandom() ? '|custom-GamepediaNotice|custom-FandomMergeNotice' : '' ) + '&siprop=general|statistics|languages|rightsinfo' + ( wiki.isFandom() ? '|variables' : '' ) + '&siinlanguagecode=' + uselang + '&list=logevents&ledir=newer&lelimit=1&leprop=timestamp&titles=Special:Statistics&format=json' ).then( response => {
  19. var body = response.body;
  20. if ( body && body.warnings ) log_warn(body.warnings);
  21. if ( response.statusCode !== 200 || !body || body.batchcomplete === undefined || !body.query || !body.query.pages ) {
  22. if ( wiki.noWiki(response.url, response.statusCode) ) {
  23. console.log( '- This wiki doesn\'t exist!' );
  24. msg.reactEmoji('nowiki');
  25. }
  26. else {
  27. console.log( '- ' + response.statusCode + ': Error while getting the statistics: ' + ( body && body.error && body.error.info ) );
  28. msg.sendChannelError( spoiler + '<' + wiki.toLink('Special:Statistics', querystring, fragment) + '>' + spoiler );
  29. }
  30. if ( reaction ) reaction.removeEmoji();
  31. return;
  32. }
  33. wiki.updateWiki(body.query.general);
  34. logging(wiki, msg.guildId, 'overview');
  35. var version = [lang.get('overview.version'), body.query.general.generator];
  36. var creation_date = null;
  37. var created = [lang.get('overview.created'), lang.get('overview.unknown'), ''];
  38. try {
  39. var dateformat = new Intl.DateTimeFormat(lang.get('dateformat'), Object.assign({
  40. timeZone: body.query.general.timezone
  41. }, timeoptions));
  42. }
  43. catch ( error ) {
  44. var dateformat = new Intl.DateTimeFormat(lang.get('dateformat'), Object.assign({
  45. timeZone: 'UTC'
  46. }, timeoptions));
  47. }
  48. if ( body.query.logevents?.[0]?.timestamp ) {
  49. creation_date = new Date(body.query.logevents[0].timestamp);
  50. created[1] = dateformat.format(creation_date);
  51. created[2] = '<t:' + Math.trunc(creation_date.getTime() / 1000) + ':R>';
  52. }
  53. var language = [lang.get('overview.lang'), body.query.languages.find( language => {
  54. return language.code === body.query.general.lang;
  55. } )['*']];
  56. var rtl = [lang.get('overview.rtl'), ( body.query.general.rtl !== undefined ? lang.get('overview.yes') : undefined )];
  57. var articles = [lang.get('overview.articles'), body.query.statistics.articles.toLocaleString(lang.get('dateformat'))];
  58. var pages = [lang.get('overview.pages'), body.query.statistics.pages.toLocaleString(lang.get('dateformat'))];
  59. var edits = [lang.get('overview.edits'), body.query.statistics.edits.toLocaleString(lang.get('dateformat'))];
  60. var users = [lang.get('overview.users'), body.query.statistics.activeusers.toLocaleString(lang.get('dateformat'))];
  61. var admins = [lang.get('overview.admins'), body.query.statistics.admins.toLocaleString(lang.get('dateformat'))];
  62. var license = [lang.get('overview.license'), lang.get('overview.unknown')];
  63. if ( body.query.rightsinfo.url ) {
  64. let licenseurl = body.query.rightsinfo.url
  65. if ( /^(?:https?:\/)?\//.test(licenseurl) ) licenseurl = new URL(licenseurl, wiki).href;
  66. else licenseurl = wiki.toLink(licenseurl, '', '', true);
  67. if ( body.query.rightsinfo.text ) {
  68. let licensetext = body.query.rightsinfo.text;
  69. if ( msg.showEmbed() && !noEmbed ) {
  70. license[1] = '[' + toPlaintext(licensetext, true) + '](' + licenseurl + ')';
  71. }
  72. else license[1] = toPlaintext(licensetext, true) + ' (<' + licenseurl + '>)';
  73. }
  74. else license[1] = '<' + licenseurl + '>';
  75. }
  76. else if ( body.query.rightsinfo.text ) {
  77. license[1] = toFormatting(body.query.rightsinfo.text, ( msg.showEmbed() && !noEmbed ), wiki, '', true);
  78. }
  79. var misermode = [lang.get('overview.misermode'), lang.get('overview.' + ( body.query.general.misermode !== undefined ? 'yes' : 'no' ))];
  80. var readonly = [lang.get('overview.readonly')];
  81. if ( body.query.general.readonly !== undefined ) {
  82. if ( body.query.general.readonlyreason ) {
  83. let readonlyreason = body.query.general.readonlyreason;
  84. readonly.push(toFormatting(readonlyreason, ( msg.showEmbed() && !noEmbed ), wiki, '', true));
  85. }
  86. else readonly = ['\u200b', '**' + lang.get('overview.readonly') + '**'];
  87. }
  88. var title = body.query.pages['-1'].title;
  89. var pagelink = wiki.toLink(title, querystring, fragment);
  90. var text = '<' + pagelink + '>';
  91. var embed = null;
  92. if ( msg.showEmbed() && !noEmbed ) {
  93. embed = new MessageEmbed().setAuthor( body.query.general.sitename ).setTitle( escapeFormatting(title) ).setURL( pagelink ).setThumbnail( new URL(body.query.general.logo, wiki).href );
  94. if ( body.query.allmessages?.[0]?.['*']?.trim?.() ) {
  95. let displaytitle = escapeFormatting(body.query.allmessages[0]['*'].trim());
  96. if ( displaytitle.length > 250 ) displaytitle = displaytitle.substring(0, 250) + '\u2026';
  97. embed.setTitle( displaytitle );
  98. }
  99. }
  100. else {
  101. text += '\n';
  102. }
  103. var wikiid = body.query.variables?.find?.( variable => variable?.id === 'wgCityId' )?.['*'];
  104. if ( wiki.isFandom() && wikiid ) {
  105. var vertical = [lang.get('overview.vertical')];
  106. var topic = [lang.get('overview.topic')];
  107. var official = [lang.get('overview.official')];
  108. var posts = [lang.get('overview.posts')];
  109. var walls = [lang.get('overview.walls')];
  110. var comments = [lang.get('overview.comments')];
  111. var manager = [lang.get('overview.manager'), ''];
  112. var founder = [lang.get('overview.founder')];
  113. var crossover = [lang.get('overview.crossover')];
  114. if ( body.query.allmessages?.[1]?.['*']?.trim?.() ) {
  115. crossover[1] = '<https://' + body.query.allmessages[1]['*'].trim() + '.gamepedia.com/>';
  116. }
  117. if ( body.query.allmessages?.[2]?.['*']?.trim?.() ) {
  118. let mergeNotice = body.query.allmessages[2]['*'].trim();
  119. if ( !mergeNotice.includes( '|' ) ) {
  120. mergeNotice = mergeNotice.split('/');
  121. crossover[1] = '<https://' + mergeNotice[0] + '.fandom.com/' + ( mergeNotice[1] ? '/' + mergeNotice[1] : '' ) + '>';
  122. }
  123. }
  124. var description = [lang.get('overview.description')];
  125. var image = [lang.get('overview.image')];
  126. return got.get( 'https://community.fandom.com/api/v1/Wikis/Details?ids=' + wikiid + '&format=json&cache=' + Date.now() ).then( ovresponse => {
  127. var ovbody = ovresponse.body;
  128. if ( ovresponse.statusCode !== 200 || !ovbody || ovbody.exception || !ovbody.items || !ovbody.items[wikiid] ) {
  129. console.log( '- ' + ovresponse.statusCode + ': Error while getting the wiki details: ' + ( ovbody && ovbody.exception && ovbody.exception.details ) );
  130. return;
  131. }
  132. var site = ovbody.items[wikiid];
  133. vertical[1] = site.hub;
  134. topic[1] = site.topic;
  135. founder[1] = site.founding_user_id;
  136. if ( site.creation_date && creation_date > new Date(site.creation_date) ) {
  137. creation_date = new Date(site.creation_date);
  138. created[1] = dateformat.format(creation_date);
  139. created[2] = '<t:' + Math.trunc(creation_date.getTime() / 1000) + ':R>';
  140. }
  141. if ( site.desc ) {
  142. description[1] = escapeFormatting(site.desc);
  143. if ( description[1].length > 1000 ) {
  144. description[1] = description[1].substring(0, 1000) + '\u2026';
  145. }
  146. }
  147. if ( site.image ) image[1] = new URL(site.image, wiki).href;
  148. return Promise.all([
  149. ( founder[1] > 0 ? got.get( wiki + 'api.php?action=query&list=users&usprop=&ususerids=' + founder[1] + '&format=json' ).then( usresponse => {
  150. var usbody = usresponse.body;
  151. if ( usbody && usbody.warnings ) log_warn(usbody.warnings);
  152. if ( usresponse.statusCode !== 200 || !usbody || !usbody.query || !usbody.query.users || !usbody.query.users[0] ) {
  153. console.log( '- ' + usresponse.statusCode + ': Error while getting the wiki founder: ' + ( usbody && usbody.error && usbody.error.info ) );
  154. founder[1] = 'ID: ' + founder[1];
  155. }
  156. else {
  157. var user = usbody.query.users[0].name;
  158. if ( msg.showEmbed() && !noEmbed ) founder[1] = '[' + user + '](' + wiki.toLink('User:' + user, '', '', true) + ')';
  159. else founder[1] = user;
  160. }
  161. }, error => {
  162. console.log( '- Error while getting the wiki founder: ' + error );
  163. founder[1] = 'ID: ' + founder[1];
  164. } ) : founder[1] = ( founder[1] === undefined || wiki.isGamepedia() ? null : lang.get('overview.none') ) ),
  165. got.get( wiki + 'wikia.php?controller=DiscussionPost&method=getPosts&limit=1&format=json&cache=' + Date.now(), {
  166. headers: {
  167. Accept: 'application/hal+json'
  168. }
  169. } ).then( dsresponse => {
  170. var dsbody = dsresponse.body;
  171. if ( dsresponse.statusCode !== 200 || !dsbody || dsbody.status === 404 ) {
  172. if ( dsbody?.status !== 404 ) console.log( '- ' + dsresponse.statusCode + ': Error while getting discussions stats: ' + dsbody?.title );
  173. return;
  174. }
  175. let counts = dsbody?._embedded?.count?.[0];
  176. if ( counts?.FORUM || counts?.WALL || counts?.ARTICLE_COMMENT ) {
  177. if ( counts?.FORUM ) posts.push(counts.FORUM.toLocaleString(lang.get('dateformat')));
  178. if ( counts?.WALL ) walls.push(counts.WALL.toLocaleString(lang.get('dateformat')));
  179. if ( counts?.ARTICLE_COMMENT ) comments.push(counts.ARTICLE_COMMENT.toLocaleString(lang.get('dateformat')));
  180. }
  181. else if ( counts?.total ) posts.push(counts.total.toLocaleString(lang.get('dateformat')));
  182. }, error => {
  183. console.log( '- Error while getting discussions stats: ' + error );
  184. } )
  185. ]);
  186. }, error => {
  187. console.log( '- Error while getting the wiki details: ' + error );
  188. return;
  189. } ).finally( () => {
  190. if ( msg.showEmbed() && !noEmbed ) {
  191. if ( vertical[1] ) embed.addField( vertical[0], vertical[1], true );
  192. if ( topic[1] ) embed.addField( topic[0], topic[1], true );
  193. if ( official[1] ) embed.addField( official[0], official[1], true );
  194. embed.addField( version[0], version[1], true ).addField( language[0], language[1], true );
  195. if ( rtl[1] ) embed.addField( rtl[0], rtl[1], true );
  196. embed.addField( created[0], created[1] + '\n' + created[2], true ).addField( articles[0], articles[1], true ).addField( pages[0], pages[1], true ).addField( edits[0], edits[1], true );
  197. if ( posts[1] ) embed.addField( posts[0], posts[1], true );
  198. if ( walls[1] ) embed.addField( walls[0], walls[1], true );
  199. if ( comments[1] ) embed.addField( comments[0], comments[1], true );
  200. embed.addField( users[0], users[1], true ).addField( admins[0], admins[1], true );
  201. if ( manager[1] ) embed.addField( manager[0], '[' + manager[1] + '](' + wiki.toLink('User:' + manager[1], '', '', true) + ') ([' + lang.get('overview.talk') + '](' + wiki.toLink('User talk:' + manager[1], '', '', true) + '))', true );
  202. if ( founder[1] ) embed.addField( founder[0], founder[1], true );
  203. if ( crossover[1] ) embed.addField( crossover[0], crossover[1], true );
  204. embed.addField( license[0], license[1], true ).addField( misermode[0], misermode[1], true ).setFooter( lang.get('overview.inaccurate') + ( wikiid ? ' • ' + lang.get('overview.wikiid') + ' ' + wikiid : '' ) );
  205. if ( description[1] ) embed.addField( description[0], description[1] );
  206. if ( image[1] ) embed.addField( image[0], image[1] ).setImage( image[1] );
  207. if ( readonly[1] ) embed.addField( readonly[0], readonly[1] );
  208. }
  209. else {
  210. if ( vertical[1] ) text += '\n' + vertical.join(' ');
  211. if ( topic[1] ) text += '\n' + topic.join(' ');
  212. if ( official[1] ) text += '\n' + official.join(' ');
  213. text += '\n' + version.join(' ') + '\n' + language.join(' ');
  214. if ( rtl[1] ) text += '\n' + rtl.join(' ');
  215. text += '\n' + created.join(' ') + '\n' + articles.join(' ') + '\n' + pages.join(' ') + '\n' + edits.join(' ');
  216. if ( posts[1] ) text += '\n' + posts.join(' ');
  217. if ( walls[1] ) text += '\n' + walls.join(' ');
  218. if ( comments[1] ) text += '\n' + comments.join(' ');
  219. text += '\n' + users.join(' ') + '\n' + admins.join(' ');
  220. if ( manager[1] ) text += '\n' + manager.join(' ');
  221. if ( founder[1] ) text += '\n' + founder.join(' ');
  222. if ( crossover[1] ) text += '\n' + crossover.join(' ');
  223. text += '\n' + license.join(' ') + '\n' + misermode.join(' ');
  224. if ( description[1] ) text += '\n' + description.join(' ');
  225. if ( image[1] ) text += '\n' + image.join(' ');
  226. if ( readonly[1] ) text += '\n\n' + ( readonly[0] === '\u200b' ? readonly[1] : readonly.join('\n') );
  227. text += '\n\n*' + lang.get('overview.inaccurate') + '*';
  228. }
  229. msg.sendChannel( {content: spoiler + text + spoiler, embeds: [embed]} );
  230. if ( reaction ) reaction.removeEmoji();
  231. } );
  232. }
  233. if ( msg.showEmbed() && !noEmbed ) {
  234. embed.addField( version[0], version[1], true ).addField( language[0], language[1], true );
  235. if ( rtl[1] ) embed.addField( rtl[0], rtl[1], true );
  236. embed.addField( created[0], created[1] + '\n' + created[2], true ).addField( articles[0], articles[1], true ).addField( pages[0], pages[1], true ).addField( edits[0], edits[1], true ).addField( users[0], users[1], true ).addField( admins[0], admins[1], true ).addField( license[0], license[1], true ).addField( misermode[0], misermode[1], true ).setFooter( lang.get('overview.inaccurate') );
  237. if ( readonly[1] ) embed.addField( readonly[0], readonly[1] );
  238. }
  239. else {
  240. text += '\n' + version.join(' ') + '\n' + language.join(' ');
  241. if ( rtl[1] ) text += '\n' + rtl.join(' ');
  242. text += '\n' + created.join(' ') + '\n' + articles.join(' ') + '\n' + pages.join(' ') + '\n' + edits.join(' ') + '\n' + users.join(' ') + '\n' + admins.join(' ') + '\n' + license.join(' ') + '\n' + misermode.join(' ');
  243. if ( readonly[1] ) text += '\n\n' + ( readonly[0] === '\u200b' ? readonly[1] : readonly.join('\n') );
  244. text += '\n\n*' + lang.get('overview.inaccurate') + '*';
  245. }
  246. msg.sendChannel( {content: spoiler + text + spoiler, embeds: [embed]} );
  247. if ( reaction ) reaction.removeEmoji();
  248. }, error => {
  249. if ( wiki.noWiki(error.message) ) {
  250. console.log( '- This wiki doesn\'t exist!' );
  251. msg.reactEmoji('nowiki');
  252. }
  253. else {
  254. console.log( '- Error while getting the statistics: ' + error );
  255. msg.sendChannelError( spoiler + '<' + wiki.toLink('Special:Statistics', querystring, fragment) + '>' + spoiler );
  256. }
  257. if ( reaction ) reaction.removeEmoji();
  258. } );
  259. }
  260. module.exports = {
  261. name: 'overview',
  262. run: gamepedia_overview
  263. };