overview.js 15 KB

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