Load local html content about third-party software licenses #221

keiji · 2021-06-11T01:30:52Z

Issue 番号 / Issue ID

目的 / Purpose

バージョンによって使用しているソフトウェアやフォントが変わってきている。「このバージョンからはこのライブラリ」や「このライブラリはこのバージョンまで」のような記述が重なると読みにくくなり、過去に廃止したライブラリを再度使うなどのケースで更新ミスが起こる可能性がある。

本Pull Requestは、ライセンス情報をアプリに同梱してバージョンに紐付けることで、今後のライセンス情報の更新を容易にする。

破壊的変更をもたらしますか / Does this introduce a breaking change?

[x] Yes
[ ] No

Pull Request の種類 / Pull Request type

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

検証方法 / How to test

コードの入手 / Get the code

gh pr checkout 221
dotnet restore

コードの検証 / Test the code

CIの実行結果 https://github.com/keiji/cocoa/actions/runs/926973006

確認事項 / What to check

コメントにて一定の方針が決まっているため解決とする。

ライセンスファイルCOPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.htmlは動作イメージを見るためのダミー。ファイルの生成は、MarkdownファイルからGitHub Flavorで行っている。
ライセンスファイルの名前COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.htmlは、元になったMarkdownファイルと同じにしている。
ライセンスファイルの置き場所
- Androidのassetsの直下においても良いか。iOSのようにContentディレクトリに配置するか。
- iOSのResources/Contentの下に置くので問題ないか。ファイルが一つしかないのでContentを作らないパターンの方がわかりやすい可能性がある。
ライセンス関係のファイル名がLicenseAgreement*になっているが、この画面に同意の意味合いはないのでこれはLicense*にした方が良いのではないか（リファクタリングとして別途対応するか検討）。

その他 / Other information

ライセンス表記については別途Pull Request #184 がある。

keiji · 2021-06-11T01:44:33Z

Covid19Radar/Covid19Radar.iOS/Resources/Content/COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.html

@@ -0,0 +1,1413 @@
+<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><style>body {


COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.md を元に生成しているため、現在のCOCOAが表示しているウェブ版の内容と異なる。

マージ前に差し替えが必要。

keiji · 2021-07-11T03:07:04Z

rebased

…urce or assets

cocoa-dev

@keiji

ライセンス関係のファイル名がLicenseAgreement*になっているが、この画面に同意の意味合いはないのでこれはLicense*にした方が良いのではないか（リファクタリングとして別途対応するか検討）。

私も同意です。
ただ今回の修正とは関係ないので、別 Issue & PR にしていただけると嬉しいです！

Covid19Radar/Covid19Radar/settings.json

Covid19Radar/Covid19Radar.iOS/AppDelegate.cs

Covid19Radar/Covid19Radar/AppSettings.cs

Covid19Radar/Covid19Radar.Android/Assets/COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.html

cocoa-dev · 2021-07-28T03:36:02Z

@keiji

ライセンスファイルの置き場所
Androidのassetsの直下においても良いか。iOSのようにContentディレクトリに配置するか。
iOSのResources/Contentの下に置くので問題ないか。ファイルが一つしかないのでContentを作らないパターンの方がわかりやすい可能性がある。

[修正任意]
どちらでもいいと思いますが、iOS と Android で統一したほうがわかりやすいです。
仰る通りまだファイルが 1 つしかないので、両 OS とも Resources 直下に置いてよさそうです。
増えたらフォルダを作成すればいいと思います。

Covid19Radar/Covid19Radar/Services/ILocalContentPathService.cs

Rename LocalContentPathService class to LocalContentService. The generated file name `COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.html` is now simplified `license.html`. Remove a key `licenseFilename` in settings.json.

Covid19Radar/Covid19Radar.Android/Services/LocalContentService.cs

Covid19Radar/Covid19Radar.iOS/Services/LocalContentService.cs

Covid19Radar/Covid19Radar.Android/Assets/COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.html

Co-authored-by: cocoa-dev <69558847+cocoa-dev@users.noreply.github.com>

cocoa-dev

LGTM :)
ライセンス情報を最新に更新したらマージしていいと思います！

keiji · 2021-07-29T00:58:27Z

今のライセンスファイルは、最新のCOPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.mdから生成したものなので、現在のCOCOAのコードに適合しているという認識です。

お昼頃にマージします。

…se_from_local_resource

keiji · 2021-07-30T00:39:19Z

Covid19Radar/Covid19Radar.iOS/Services/LocalContentService.cs

@@ -0,0 +1,15 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */


ライセンス通知ﾖｼｯ

keiji · 2021-07-30T00:39:26Z

Covid19Radar/Covid19Radar/Services/ILocalContentPathService.cs

@@ -0,0 +1,13 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */


ライセンス通知ﾖｼｯ

keiji · 2021-07-30T00:40:00Z

Covid19Radar/Covid19Radar.Android/Services/LocalContentService.cs

@@ -0,0 +1,16 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */


ライセンス通知ﾖｼｯ

keiji self-assigned this Jun 11, 2021

keiji commented Jun 11, 2021

View reviewed changes

keiji requested a review from cocoa-dev June 11, 2021 02:07

keiji assigned cocoa-dev Jun 13, 2021

keiji force-pushed the load_license_from_local_resource branch from 3c9928a to 7abea54 Compare July 11, 2021 03:01

keiji force-pushed the load_license_from_local_resource branch from 7abea54 to 7d5601f Compare July 13, 2021 16:02

keiji added 2 commits July 14, 2021 16:53

Load html content about third-party software licenses from local reso…

2839ab2

…urce or assets

Remove old license files

293d11c

keiji force-pushed the load_license_from_local_resource branch from 3c7d29a to 293d11c Compare July 14, 2021 07:53

cocoa-dev reviewed Jul 28, 2021

View reviewed changes

Covid19Radar/Covid19Radar/Services/ILocalContentPathService.cs Outdated Show resolved Hide resolved

Code review reflected.

e113517

Rename LocalContentPathService class to LocalContentService. The generated file name `COPYRIGHT_THIRD_PARTY_SOFTWARE_NOTICES.html` is now simplified `license.html`. Remove a key `licenseFilename` in settings.json.

keiji requested a review from cocoa-dev July 28, 2021 07:29

cocoa-dev reviewed Jul 28, 2021

View reviewed changes

keiji and others added 3 commits July 28, 2021 19:08

Update Covid19Radar/Covid19Radar.Android/Services/LocalContentService.cs

80c4c6b

Co-authored-by: cocoa-dev <69558847+cocoa-dev@users.noreply.github.com>

Update Covid19Radar/Covid19Radar.iOS/Services/LocalContentService.cs

3bad62d

Co-authored-by: cocoa-dev <69558847+cocoa-dev@users.noreply.github.com>

Fix build error.

e19c683

keiji requested a review from cocoa-dev July 28, 2021 12:32

cocoa-dev approved these changes Jul 28, 2021

View reviewed changes

Merge branch 'develop' of github.com:cocoa-mhlw/cocoa into load_licen…

e6ad02e

…se_from_local_resource

keiji commented Jul 30, 2021

View reviewed changes

keiji merged commit 84b00bd into cocoa-mhlw:develop Jul 30, 2021

keiji mentioned this pull request Jul 30, 2021

接触判定時にローカル通知を表示する #299

Merged

keiji deleted the load_license_from_local_resource branch August 19, 2021 03:12

kazuhiro4949 mentioned this pull request Jan 20, 2022

ライセンスファイルの差し替え #787

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load local html content about third-party software licenses #221

Load local html content about third-party software licenses #221

keiji commented Jun 11, 2021 •

edited by cocoa-dev

Loading

keiji Jun 11, 2021

keiji commented Jul 11, 2021

cocoa-dev left a comment

cocoa-dev commented Jul 28, 2021

cocoa-dev left a comment

keiji commented Jul 29, 2021

keiji Jul 30, 2021

keiji Jul 30, 2021

keiji Jul 30, 2021

		@@ -0,0 +1,1413 @@
		<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><style>body {

Load local html content about third-party software licenses #221

Load local html content about third-party software licenses #221

Conversation

keiji commented Jun 11, 2021 • edited by cocoa-dev Loading

Issue 番号 / Issue ID

目的 / Purpose

破壊的変更をもたらしますか / Does this introduce a breaking change?

Pull Request の種類 / Pull Request type

検証方法 / How to test

コードの入手 / Get the code

コードの検証 / Test the code

確認事項 / What to check

その他 / Other information

keiji Jun 11, 2021

Choose a reason for hiding this comment

keiji commented Jul 11, 2021

cocoa-dev left a comment

Choose a reason for hiding this comment

cocoa-dev commented Jul 28, 2021

cocoa-dev left a comment

Choose a reason for hiding this comment

keiji commented Jul 29, 2021

keiji Jul 30, 2021

Choose a reason for hiding this comment

keiji Jul 30, 2021

Choose a reason for hiding this comment

keiji Jul 30, 2021

Choose a reason for hiding this comment

keiji commented Jun 11, 2021 •

edited by cocoa-dev

Loading