从 xpi 包获取 id 和 description #49

northword · 2023-11-28T14:39:39Z

ref: #41

修改 ts-node 为 tsc，因为 ts-node + Node.js 20.x + ESM 似乎不兼容，见
- ts-node doesn't run ESM modules as expected, either refusingimport statements in ts file or not being able to run .ts files TypeStrong/ts-node#2086
- Node 20: errors produced by reportTSError are not serialised correctly when using ESM loader TypeStrong/ts-node#2026
从 xpi 获取 plugin.id，若 plugin.description 为空，则从 xpi 补全。

待办：补全 description，install.rdf 结构居然不一样，需要额外适配一下：

<?xml version="1.0"?>
<RDF:RDF
    xmlns:em="http://www.mozilla.org/2004/em-rdf#"
    xmlns:NC="http://home.netscape.com/NC-rdf#"
    xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
    <RDF:Description
        RDF:about="urn:mozilla:install-manifest"
        em:id="zotero-format-metadata@northword.cn"
        em:name="Zotero Format Metadata"
        em:version="0.4.4"
        em:type="2"
        em:creator="northword"
        em:description="An addon for Zotero to format item metadata"
        em:homepageURL="https://github.com/northword/zotero-format-metadata#readme"
        em:iconURL="chrome://formatmetadata/content/icons/favicon.png"
        em:optionsURL="chrome://formatmetadata/content/preferences.xul"
        em:updateURL="https://github.com/northword/zotero-format-metadata/releases/latest/download/update.json"
        em:multiprocessCompatible="true"
        em:bootstrap="true">
        <em:targetApplication>
            <Description>
                <em:id>zotero@chnm.gmu.edu</em:id>
                <em:minVersion>5.0</em:minVersion>
                <em:maxVersion>*</em:maxVersion>
            </Description>
        </em:targetApplication>
        <em:targetApplication>
            <Description>
                <em:id>juris-m@juris-m.github.io</em:id>
                <em:minVersion>5.0</em:minVersion>
                <em:maxVersion>*</em:maxVersion>
            </Description>
        </em:targetApplication>
  </RDF:Description>
</RDF:RDF>

<?xml version="1.0" encoding="utf-8"?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:em="http://www.mozilla.org/2004/em-rdf#">

    <Description about="urn:mozilla:install-manifest">
        <em:id>keepzotero@yhmtsai</em:id>
        <em:name>KeepZotero</em:name>
        <em:version>0.0.2</em:version>
        <em:type>2</em:type>
        <em:multiprocessCompatible>true</em:multiprocessCompatible>
        <em:optionsURL>chrome://keepzotero/content/options.xul</em:optionsURL>
        <em:updateURL>https://raw.githubusercontent.com/yhmtsai/KeepZotero/master/keepzotero-update.rdf</em:updateURL>
        <em:creator>Yu-Hsiang Mike Tsai</em:creator>

        <em:targetApplication>
            <Description>
                <em:id>zotero@chnm.gmu.edu</em:id>
                <em:minVersion>5.0.0</em:minVersion>
                <em:maxVersion>6.0.*</em:maxVersion>
            </Description>
        </em:targetApplication>
        <em:localized>
            <Description>
                <em:locale>en-US</em:locale>
                <em:name>KeepZotero</em:name>
                <em:description>Keep Zotero in Taskbar</em:description>
            </Description>
        </em:localized>
    </Description>
</RDF>

奇怪的 rdf 再加一：（em:id）

<?xml version="1.0"?>
<RDF:RDF
    xmlns:em="http://www.mozilla.org/2004/em-rdf#"
    xmlns:NC="http://home.netscape.com/NC-rdf#"
    xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
    <RDF:Description
        RDF:about="rdf:#$x61SL3"
        em:id="{7B7BE31E-0C0F-436B-8A26-4C199B543C9E}"
        em:minVersion="2.0"
        em:maxVersion="20.*"/>
    <RDF:Description
        RDF:about="urn:mozilla:install-manifest"
        em:id="zoterozotcard@018.ai"
        em:name="ZotCard"
        em:version="2.8.1"
        em:type="2"
        em:iconURL="chrome://zoterozotcard/skin/zotcard.png"
        em:icon64URL="chrome://zoterozotcard/skin/zotcard64.png"
        em:creator="018"
        em:description="写卡更柔顺，读卡更顺滑。"
        em:homepageURL="https://github.com/018/zotcard"
        em:updateURL="https://raw.githubusercontent.com/018/zotcard/main/update.rdf">
        <em:type>2</em:type>
        <em:targetApplication RDF:resource="rdf:#$x61SL3"/>
        <em:targetApplication>
            <Description>
                <em:id>zotero@chnm.gmu.edu</em:id>
                <em:minVersion>5.0.66</em:minVersion>
                <em:maxVersion>*</em:maxVersion>
            </Description>
        </em:targetApplication>
    </RDF:Description>
</RDF:RDF>

syt2 · 2023-11-29T03:03:58Z

~~可能对于zotcard的也需要特地适配下~~

可供参考的信息
firefox XPIInstall
firefox addon.py
addon-scraper

另外，是否需要考虑对于同时存在z6、z7的插件，开发者使用了不同的id的极端情况？(目前未遇到)

无法正确获取到极个别插件id

northword · 2023-11-29T03:14:02Z

另外，是否需要考虑对于同时存在z6、z7的插件，开发者使用了不同的id的极端情况？(目前未遇到)

严格的来说，id 变更就意味着已经是两个插件了，所以我觉得可以不用考虑？（主要是现在也没遇到）（我的想法是以从7里面获取到的为主）

syt2 · 2023-11-29T03:27:31Z

另外，是否需要考虑对于同时存在z6、z7的插件，开发者使用了不同的id的极端情况？(目前未遇到)

严格的来说，id 变更就意味着已经是两个插件了，所以我觉得可以不用考虑？（主要是现在也没遇到）（我的想法是以从7里面获取到的为主）

考虑了下也行，如果真遇到了，在plugins内把对应插件拆成两个就行。

northword · 2023-11-29T04:11:10Z

另外，是否需要考虑对于同时存在z6、z7的插件，开发者使用了不同的id的极端情况？(目前未遇到)

严格的来说，id 变更就意味着已经是两个插件了，所以我觉得可以不用考虑？（主要是现在也没遇到）（我的想法是以从7里面获取到的为主）

考虑了下也行，如果真遇到了，在plugins内把对应插件拆成两个就行。

或者就是，id 不放 PluginInfo.id ，而是 PluginInfo.ReleaseInfo.id ?

syt2 · 2023-11-29T06:06:48Z

另外，是否需要考虑对于同时存在z6、z7的插件，开发者使用了不同的id的极端情况？(目前未遇到)

严格的来说，id 变更就意味着已经是两个插件了，所以我觉得可以不用考虑？（主要是现在也没遇到）（我的想法是以从7里面获取到的为主）

考虑了下也行，如果真遇到了，在plugins内把对应插件拆成两个就行。

或者就是，id 不放 PluginInfo.id ，而是 PluginInfo.ReleaseInfo.id ?

两种方案都可行吧。
我在zotero-addons-scraper里暂时两个都放了，等着这个仓库的格式同步修改脚本和插件去👀

northword · 2023-11-29T07:54:48Z

下面是没有考虑不同版本 id 不同的，感觉应该是和 zotero-addons-scraper 比较接近的，你看下需不需要修改呢？

优先从 manifest.json 中获取，如果不存在这个文件，才从 install.rdf 获取。

另外为了节省传输的体积， plugins.json取消了缩进，大约从 71kb -> 58kb。

[
  {
    "name": "Zotero Format Metadata",
    "repo": "northword/zotero-format-metadata",
    "releases": [
      {
        "targetZoteroVersion": "7",
        "tagName": "latest",
        "currentVersion": "1.6.11",
        "assetId": 135864033,
        "releaseData": "2023-11-16T14:35:35Z",
        "downloadCount": 2250,
        "xpiDownloadUrl": {
          "github": "https://github.com/northword/zotero-format-metadata/releases/download/1.6.11/zotero-format-metadata.xpi",
          "gitee": "https://gitee.com/northword/zotero-plugins/raw/gh-pages/dist/xpi/135864033.xpi",
          "ghProxy": "https://ghproxy.com/?q=https://github.com/northword/zotero-format-metadata/releases/download/1.6.11/zotero-format-metadata.xpi",
          "jsdeliver": "https://cdn.jsdelivr.net/gh/northword/zotero-plugins@gh-pages/dist/xpi/135864033.xpi",
          "kgithub": "https://kkgithub.com/northword/zotero-format-metadata/releases/download/1.6.11/zotero-format-metadata.xpi"
        }
      },
      {
        "targetZoteroVersion": "6",
        "tagName": "0.4.4",
        "currentVersion": "0.4.4",
        "assetId": 112232528,
        "releaseData": "2023-06-11T06:51:01Z",
        "downloadCount": 12669,
        "xpiDownloadUrl": {
          "github": "https://github.com/northword/zotero-format-metadata/releases/download/0.4.4/zotero-format-metadata.xpi",
          "gitee": "https://gitee.com/northword/zotero-plugins/raw/gh-pages/dist/xpi/112232528.xpi",
          "ghProxy": "https://ghproxy.com/?q=https://github.com/northword/zotero-format-metadata/releases/download/0.4.4/zotero-format-metadata.xpi",
          "jsdeliver": "https://cdn.jsdelivr.net/gh/northword/zotero-plugins@gh-pages/dist/xpi/112232528.xpi",
          "kgithub": "https://kkgithub.com/northword/zotero-format-metadata/releases/download/0.4.4/zotero-format-metadata.xpi"
        }
      }
    ],
    "description": "Linter for Zotero. An addon for Zotero to format item metadata. Shortcut to set rich text, set journal abbreviations, university places, item languages, etc.",
    "star": 164,
    "watchers": 164,
    "author": {
      "name": "Northword",
      "url": "https://northword.dev",
      "avatar": "https://avatars.githubusercontent.com/u/44738481?v=4"
    },
    "id": "zotero-format-metadata@northword.cn"
  },
  {
    "name": "Chartero",
    "repo": "volatile-static/Chartero",
    "releases": [
      {
        "targetZoteroVersion": "6",
        "tagName": "latest",
        "currentVersion": "2.2.0",
        "assetId": 137018637,
        "releaseData": "2023-11-23T05:28:49Z",
        "downloadCount": 1278,
        "xpiDownloadUrl": {
          "github": "https://github.com/volatile-static/Chartero/releases/download/2.2.0/chartero.xpi",
          "gitee": "https://gitee.com/northword/zotero-plugins/raw/gh-pages/dist/xpi/137018637.xpi",
          "ghProxy": "https://ghproxy.com/?q=https://github.com/volatile-static/Chartero/releases/download/2.2.0/chartero.xpi",
          "jsdeliver": "https://cdn.jsdelivr.net/gh/northword/zotero-plugins@gh-pages/dist/xpi/137018637.xpi",
          "kgithub": "https://kkgithub.com/volatile-static/Chartero/releases/download/2.2.0/chartero.xpi"
        }
      }
    ],
    "description": "Chart in Zotero",
    "star": 233,
    "watchers": 233,
    "author": {
      "name": "volatile-static",
      "url": "https://github.com/volatile-static",
      "avatar": "https://avatars.githubusercontent.com/u/59945270?v=4"
    },
    "id": "chartero@volatile.static"
  }
]

syt2 · 2023-11-29T08:45:46Z

get，没问题

northword · 2023-11-29T10:17:07Z

CC @volatile-static , 这个 PR 里变更了 ts-node，也许你要看下你那边能不能正常运行（我觉得是没啥问题的）

src/get_plugins_info.ts

volatile-static · 2023-11-29T13:30:05Z

CC @volatile-static , 这个 PR 里变更了 ts-node，也许你要看下你那边能不能正常运行（我觉得是没啥问题的）

我暂时不需要本地跑了。你那边测着正常就ok

resolve: #49 (comment)

northword added 4 commits November 28, 2023 22:26

chore: 修改ts-node为tsx

4476717

从 xpi 包获取 id 和 description

8f989d4

update deps

0057cec

update ci node version

e4d6e05

正则匹配id和desc

24f90eb

无法正确获取到极个别插件id

对rdf，通过xml2js获取id，通过正则获取desc

ef6b626

This comment was marked as outdated.

Sign in to view

northword marked this pull request as ready for review November 29, 2023 07:14

northword marked this pull request as draft November 29, 2023 07:26

tweak

19d8535

northword marked this pull request as ready for review November 29, 2023 07:56

CI不输出debug用的plugin-debug.json

e2e39d2

northword requested a review from volatile-static November 29, 2023 10:15

volatile-static requested changes Nov 29, 2023

View reviewed changes

src/get_plugins_info.ts Outdated Show resolved Hide resolved

纠正watcher数量为subscribers_count

ed9451b

resolve: #49 (comment)

volatile-static approved these changes Nov 30, 2023

View reviewed changes

northword merged commit 8c4ded4 into main Nov 30, 2023

northword deleted the add-id branch November 30, 2023 00:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

从 xpi 包获取 id 和 description #49

从 xpi 包获取 id 和 description #49

northword commented Nov 28, 2023 •

edited

syt2 commented Nov 29, 2023 •

edited

northword commented Nov 29, 2023

syt2 commented Nov 29, 2023

northword commented Nov 29, 2023

syt2 commented Nov 29, 2023

This comment was marked as outdated.

northword commented Nov 29, 2023 •

edited

syt2 commented Nov 29, 2023

northword commented Nov 29, 2023

volatile-static commented Nov 29, 2023

从 xpi 包获取 id 和 description #49

从 xpi 包获取 id 和 description #49

Conversation

northword commented Nov 28, 2023 • edited

syt2 commented Nov 29, 2023 • edited

northword commented Nov 29, 2023

syt2 commented Nov 29, 2023

northword commented Nov 29, 2023

syt2 commented Nov 29, 2023

This comment was marked as outdated.

northword commented Nov 29, 2023 • edited

syt2 commented Nov 29, 2023

northword commented Nov 29, 2023

volatile-static commented Nov 29, 2023

northword commented Nov 28, 2023 •

edited

syt2 commented Nov 29, 2023 •

edited

northword commented Nov 29, 2023 •

edited