heStudio BingWallpaper Get

undefined2023年2月5日约 2863 字大约 10 分钟

调用方法

提示

运行端口在3000

获取图片

GET /getimage

获取图片标题

GET /gettitle

返回参数：

参数	说明
`title`	标题

获取图片版权信息

GET /getcopyright

返回参数：

参数	说明
`copyright`	版权信息
`copyrightlink`	版权信息所对应的链接

安装方法

Docker 部署 (推荐)

docker pull hestudio/bingwallpaper_get
docker run -d -p 3000:3000 hestudio/bingwallpaper_get

NPM 安装

npm install hestudio-bingwallpaper-get
echo "require('hestudio-bingwallpaper-get')" >> server.js
node server.js

手动安装 (不推荐，仅开发人员使用)

git clone https://github.com/hestudio-community/bing-wallpaper-get.git
cd bing-wallpaper-get
npm install -global pnpm
pnpm install
pnpm run server

警告

请在更新版本之前仔细阅读版本更新日志，并决定是否更新版本。盲目的更新版本可能会导致程序崩溃。建议在更新之前请先记录之前版本的版本号，在遇到兼容问题时可以回退到之前的版本。

注意

我们将在v1.3.2版本之后将开发时使用的包管理器切换到pnpm，建议使用手动部署的也使用pnpm包管理器，Docker部署和NPM部署的用户不受影响。

提交问题

https://github.com/hestudio-community/bing-wallpaper-get/issues

高级用法

小白慎入

在使用高级用法之前，你需要了解nodejs,docker,javascript和linux的一些知识。如果你是小白，你应当只使用基本用法。

假设条件

在下文中，我们将假设你将服务运行在localhost:3000

请根据自己的实际需求按需修改，默认配置并不适合所有人

环境变量

`hbwg_external`: 外部文件路径

默认值: ./external.js
注意：external.js如手动修改，需在环境变量输入绝对值

`hbwg_getupdate`: 是否检查更新

默认值: true
注意，你应当只传入false以禁用自动检查更新。如果你不需要禁用自动检查更新，应当传入true或者不传入任何值。

警告

我们已经在v1.3.1将此开关移至external.js文件，请浏览检查更新开关。

请注意，我们已在v1.4.0版本移除此环境变量。

`hbwg_packageurl`: `package.json`对应 URL

默认值: https://registry.npmjs.com/hestudio-bingwallpaper-get/latest

镜像源

以下是几个我们认可的 CDN 源。当然，你也可以自定义成你自己的 CDN 源。

`hbwg_header`: 传入真实 IP 的请求头 v1.4.2

默认值: x-forwarded-for

注意

请注意，该请求头可以被篡改，具体请参考X-Forwarded-For - HTTP | MDN

`hbwg_tempdir`: 修改缓存目录

默认值为项目根目录的tmp文件夹
需输入绝对值，如/workspace/bing-wallpaper-get/tmp

修改组件行为

修改前你需要在根目录创建external.js文件。你可以自定义创建的路径和文件名称，只需添加hbwg_external环境变量即可。

在开始这部分内容之前，你需要了解以下内容。

本项目导出了 5 个项目函数用于日志记录。它们分别是getback(ip, path), postback(ip, path), logback(log), logerr(err), logwarn(warn)。我们分别来讲一下：

`getback(ip, path)`

参数	参数类型
`ip`	`String`
`path`	`String`

输出效果大概是这样:

[YYYY-MM-DD HH:mm:ss] ${ip} GET ${path}

`postback(ip, path)`

参数	参数类型
`ip`	`String`
`path`	`String`

输出效果大概是这样:

[YYYY-MM-DD HH:mm:ss] ${ip} POST ${path}

`logback(log)`

参数	参数类型
`log`	`String`

输出效果大概是这样:

[YYYY-MM-DD HH:mm:ss] ${log}

`logerr(err)`

参数	参数类型
`err`	`String`

输出效果大概是这样:

[YYYY-MM-DD HH:mm:ss] ERROR: ${err}

参数	参数类型
`warn`	`String`

`getupdate`: 获取更新开关

此开关决定系统是否提示更新版本。

在默认状态下，这个开关是开启状态。程序会在刚开始运行时和每个资源刷新周期自动请求更新源。如果检测到更新源有更新的版本，将会在日志中提示。

提示

不会自动更新本程序，仅提示更新。

如果需要禁用更新提示，可以在external.js中进行如下修改。

// external.js

module.exports = {
  getupdate: false;
}

`rootprogram`: 自定义`GET /`的行为

注意

修改此部分需要你额外具有express.js的知识。如果不是太了解，可以参考：

在默认情况下，访问localhost:3000会跳转到这里，你可以通过修改rootprogram函数以修改此行为。

示例项目如下：

// external.js

module.exports = {
  rootprogram: (req, res) => {
    //在这里修改内容
    res.send("helloworld");
  },
};

示例

一个输出程序配置信息的示例程序，你应当仅在开发调试环境使用

// external.js

const {
  hbwgConfig,
} = require(`${process.cwd()}/node_modules/hestudio-bingwallpaper-get`);

module.exports = {
  rootprogram: (req, res) => {
    res.send(hbwgConfig);
  },
};

`beforestart`: 在服务运行前导入代码

在开始这部分内容之前，你需要了解以下内容。

本组件中导入了app变量，该变量由express.js导入，修改此部分需要你额外具有express.js的知识。如果不是太了解，可以参考：

你不能使用app.listen()，因为这会导致项目出现致命错误。当然，你也不能将 URL 路由至/, /getimage, /geititle, /getcopyright等，它们也会导致项目无法正常运行。你可以自定义/，但是仅限于GET请求。如果需要自定义/，请参考rootprogram函数。

好的，现在可以通过以下结构在服务运行前导入代码

// external.js

module.exports = {
  beforestart: (app) => {
    //在这里修改内容
  },
};

`refreshtime`: 设置资源刷新时间

在修改本部分内容之前，需要了解一下node-schedule

已导入rule变量，需修改 rule 变量才能有效果。

官方教程

Recurrence Rule Scheduling

You can build recurrence rules to specify when a job should recur. For instance, consider this rule, which executes the function every hour at 42 minutes after the hour:

const schedule = require("node-schedule");

const rule = new schedule.RecurrenceRule();
rule.minute = 42;

const job = schedule.scheduleJob(rule, function () {
  console.log("The answer to life, the universe, and everything!");
});

You can also use arrays to specify a list of acceptable values, and the Range object to specify a range of start and end values, with an optional step parameter. For instance, this will print a message on Thursday, Friday, Saturday, and Sunday at 5pm:

const rule = new schedule.RecurrenceRule();
rule.dayOfWeek = [0, new schedule.Range(4, 6)];
rule.hour = 17;
rule.minute = 0;

const job = schedule.scheduleJob(rule, function () {
  console.log("Today is recognized by Rebecca Black!");
});

Timezones are also supported. Here is an example of executing at the start of every day in the UTC timezone.

const rule = new schedule.RecurrenceRule();
rule.hour = 0;
rule.minute = 0;
rule.tz = "Etc/UTC";

const job = schedule.scheduleJob(rule, function () {
  console.log("A new day has begun in the UTC timezone!");
});

A list of acceptable tz (timezone) values can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

RecurrenceRule properties

second (0-59)
minute (0-59)
hour (0-23)
date (1-31)
month (0-11)
year
dayOfWeek (0-6) Starting with Sunday
tz

Note: It's worth noting that the default value of a component of a recurrence rule is null (except for second, which is 0 for familiarity with cron). If we did not explicitly set minute to 0 above, the message would have instead been logged at 5:00pm, 5:01pm, 5:02pm, ..., 5:59pm. Probably not what you want.

以下是示例代码，当然，它也是项目默认配置：

// external.js

module.exports = {
  refreshtime: (rule) => {
    //在这里修改内容
    rule.hour = 0;
    rule.minute = 0;
    rule.second = 0;
    rule.tz = "Asia/Shanghai";
  },
};

设置 API 配置

修改 API 对应路径

module.exports = {
  api: {
    rename: {
      getimage: "/getimage",
      gettitle: "/gettitle",
      getcopyright: "/getcopyright",
    },
  },
};

禁用 API

module.exports = {
  api: {
    ban: ["getimage", "gettitle", "getcopyright"],
  },
};

`robots.txt`

添加默认robots.txt，默认禁止所有搜索引擎爬取。

可以关闭，通过：

module.exports = {
  robots: false,
};

可以指定代码。

module.exports = {
  robots: `
User-agent: *
Disallow: /
`,
};

`/debug` 调试接口 v1.4.2

默认关闭，可在external.js中开启

module.exports = {
  debug: true,
};

允许修改默认 URL

module.exports = {
  debug: {
    url: "/debug",
  },
};

允许修改method

module.exports = {
  debug: {
    method: "POST", // GET 或者 POST
  },
};

我们允许使用GET和POST两种方式访问调试接口。如果你不填写该值，则默认为GET

允许加设密码

module.exports = {
  debug: {
    passwd: "yourpassword",
  },
};

开发者可以如下格式在浏览器访问：

/debug?passwd=yourpassword

警告

请注意，在GET的query中使用密码是及其不明智的。如果使用密码，请改用POST

我们将在v1.4.3版本禁止在GET模式下使用密码启动 Debug Mode，如果在后续的版本仍然使用GET密码，我们将不允许你启动服务器。

返回 bing 服务器原始请求结果 (`/bingsrc`)

用户可以通过 GET /bingsrc 获取
默认禁用，可以通过external.js开启

module.exports = {
  bingsrc: true,
};

允许修改默认 URL

module.exports = {
  bingsrc: {
    url: "/bingsrc",
  },
};

定时任务

开发者可以在服务器刷新资源时自定义执行一些任务。

你可以使用AllowRefreshtaskWithFail来决定是否在更新资源失败的情况下运行定时任务。默认是关闭状态。

module.exports = {
  refreshtask: () => {
    // 这里面是你要执行的定时任务
  },
  AllowRefreshtaskWithFail: false,
};

示例

同样，我们提供了一个应用该项目的示例，该示例可以为你的 Windows 电脑自动更换壁纸。

const { hbwgConfig, logback } = require("hestudio-bingwallpaper-get");
const fs = require("fs");
const { exec } = require("child_process");

module.exports = {
  refreshtask: () => {
    logback("Outputing wallpaper.jpg ...");
    const imagePath = `${hbwgConfig.tempDir}/wallpaper.jpg`;
    fs.writeFileSync(imagePath, hbwgConfig.image);
    logback("Outputing wallpaper.jpg done");
    logback("Setting wallpaper ...");
    exec(
      `reg add "HKCU\\Control Panel\\Desktop" /v Wallpaper /t REG_SZ /d "${imagePath}" /f`,
      (error, stdout) => {
        logback(stdout);
        if (error) {
          logback(`Failed to set wallpaper: ${error}`);
        } else {
          exec(
            `RUNDLL32.EXE user32.dll,UpdatePerUserSystemParameters`,
            (error, stdout) => {
              logback(stdout);
              if (error) {
                logback(`Failed to set wallpaper: ${error}`);
              } else {
                logback("Setting wallpaper done");
              }
            }
          );
        }
      }
    );
  },
  debug: {
    method: "GET",
  },
  api: {
    ban: ["getimage", "gettitle", "getcopyright"],
  },
};

在该示例中，程序在每次下拉更新的时候更换你的电脑壁纸，并开启了调试功能。该项目可以在 https://github.com/hestudio-community/hbwg-desktop-example 找到。该示例默认端口为18981，并非默认的3000端口。请在你的电脑上使用的时候禁用掉18981端口的入站请求，防止你的电脑隐私泄露。

heStudio BingWallpaper Get

demo

调用方法

获取图片

获取图片标题

获取图片版权信息

安装方法

在其他地方找到本项目

提交问题

高级用法

环境变量

`hbwg_port`: 自定义程序端口

`hbwg_host`: 自定义 Bing 前置 URL

`hbwg_config`: 自定义请求参数

`hbwg_external`: 外部文件路径

`hbwg_getupdate`: 是否检查更新

`hbwg_packageurl`: `package.json`对应 URL

`hbwg_header`: 传入真实 IP 的请求头 v1.4.2

`hbwg_tempdir`: 修改缓存目录

修改组件行为

`getback(ip, path)`

`postback(ip, path)`

`logback(log)`

`logerr(err)`

`logwarn(warn)`

`getupdate`: 获取更新开关

`rootprogram`: 自定义`GET /`的行为

`beforestart`: 在服务运行前导入代码

`refreshtime`: 设置资源刷新时间

设置 API 配置

修改 API 对应路径

禁用 API

`robots.txt`

`/debug` 调试接口 v1.4.2

返回 bing 服务器原始请求结果 (`/bingsrc`)

定时任务

示例