overview.js 15 KB

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