overview.js 15 KB

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