Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement MediaWiki REST API render #1926

Closed
wants to merge 8 commits into from
Prev Previous commit
Next Next commit
Refactor getArticleUrl() function (partial impl)
VadimKovalenkoSNF committed Oct 23, 2023
commit c7a9228def92cc6d38484b7156f06041b2e67cbc
7 changes: 7 additions & 0 deletions src/renderers/mediawiki-rest-api.renderer.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { WikimediaDesktopRenderer } from './wikimedia-desktop.renderer.js'

export class MediawikiRESTApiRenderer extends WikimediaDesktopRenderer {
constructor() {
super()
}
}
7 changes: 4 additions & 3 deletions src/renderers/renderer.builder.ts
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@ import { Renderer } from './abstract.renderer.js'
import { VisualEditorRenderer } from './visual-editor.renderer.js'
import { WikimediaDesktopRenderer } from './wikimedia-desktop.renderer.js'
import { WikimediaMobileRenderer } from './wikimedia-mobile.renderer.js'
import { MediawikiRESTApiRenderer } from './mediawiki-rest-api.renderer.js'
import { RendererBuilderOptions } from './abstract.renderer.js'
import * as logger from './../Logger.js'

@@ -25,7 +26,7 @@ export class RendererBuilder {
} else if (hasVisualEditorApi) {
return new VisualEditorRenderer()
} else if (hasMediaWikiRESTApi) {
return new WikimediaDesktopRenderer()
return new MediawikiRESTApiRenderer()
} else {
logger.error('No available desktop renderer.')
process.exit(1)
@@ -45,7 +46,7 @@ export class RendererBuilder {
} else if (hasWikimediaMobileApi) {
return new WikimediaMobileRenderer()
} else if (hasMediaWikiRESTApi) {
return new WikimediaDesktopRenderer()
return new MediawikiRESTApiRenderer()
} else {
logger.error('No render available at all.')
process.exit(1)
@@ -67,7 +68,7 @@ export class RendererBuilder {
process.exit(1)
case 'MediawikiRESTApi':
if (hasMediaWikiRESTApi) {
return new WikimediaDesktopRenderer()
return new MediawikiRESTApiRenderer()
}
logger.error('Cannot create an instance of MediawikiRESTApi renderer.')
process.exit(1)
20 changes: 17 additions & 3 deletions src/util/saveArticles.ts
Original file line number Diff line number Diff line change
@@ -11,6 +11,9 @@ import { jsPath } from './index.js'
import { config } from '../config.js'
import { getSizeFromUrl, cleanupAxiosError } from './misc.js'
import { CONCURRENCY_LIMIT, DELETED_ARTICLE_ERROR, MAX_FILE_DOWNLOAD_RETRIES } from './const.js'
import DesktopURLDirector from './builders/url/desktop.director.js'
import VisualEditorURLDirector from './builders/url/visual-editor.director.js'
import MediaWikiRESTApiDirector from './builders/url/mediawiki-rest-api.director.js'
import urlHelper from './url.helper.js'
import urlBuilder from './builders/url/url.builder.js'
import { Renderer } from '../renderers/abstract.renderer.js'
@@ -225,8 +228,20 @@ async function saveArticle(
}
}

export function getArticleUrl(downloader: Downloader, dump: Dump, articleId: string): string {
return urlBuilder.buildArticleUrl(dump.isMainPage(articleId) ? downloader.baseUrlForMainPage : downloader.baseUrl, articleId)
export function getArticleUrl(renderer, downloader: Downloader, dump: Dump, articleId: string): string {
let articleUrl
switch (renderer.constructor.name) {
case 'WikimediaDesktopRenderer':
articleUrl = this.wikimediaDesktopUrlDirector.buildArticleURL(articleId)
break
case 'VisualEditorRenderer':
articleUrl = this.visualEditorURLDirector.buildArticleURL(articleId)
break
case 'MediawikiRESTApiRenderer':
articleUrl = this.mediaWikiRESTApiDirector.buildArticleURL(this.apiCheckArticleId)
break
}
return articleUrl
}

/*
@@ -296,7 +311,6 @@ export async function saveArticles(zimCreator: ZimCreator, downloader: Downloade
try {
const isMainPage = dump.isMainPage(articleId)
const renderer = isMainPage ? mainPageRenderer : articlesRenderer

const articleUrl = downloader.getArticleUrl(dump, articleId)

rets = await downloader.getArticle(downloader.webp, _moduleDependencies, articleId, articleDetailXId, renderer, articleUrl, dump, articleDetail, isMainPage)