NS高キャンパスの図書管理システム開発！

Flaskを用いたCPの「図書管理システム開発」の概要

制作デモページ

制作中のものになりますが、９割型完成しています。
ngrokを使用したデモになるので、自宅でProgramを動かしてないときは止まります。
基本的にこの記事公開中は動かしっぱにしておく予定ですが、メンテナンスの影響で停止させることや想定外のエラーで停止する可能性があります。
データベースなどは、テスト用のデータなので、アカウント登録などは自由にやっていただいて大丈夫です。
https://frank-sole-boss.ngrok-free.app/

制作意図

筆者が通学するNS高等学校"F"キャンパスには３００冊以上の先輩や歴代のキャンパス長が寄贈していただいた本が多くあり、もっと管理を確実にしてより多くの人ひとに本の魅力を伝えたいという思いから制作を決意しました。

過去情報

本システムには、それ以前に使用されていたシステムを元に再度設計をしています。
図書管理システムVersion1→スプレッドシートの設計のため、使用非推奨
図書管理システムVersion2→システム設計中止
図書管理システムVersion3(本システム)→製作途中のため、GitHubは限定公開

記事に関して

あまり詳しくないひとでも読みやすいようにロジック的なことは極力含まないようにしますね！！

環境

開発環境

• 開発環境は以下のとおりです。
• M1 MacBook Air （Windows10とラズパイOS　で動作確認中）
• Mac OS Ventura 13.4.1 → Sonoma 14.0
• Python3.11.4
• venvを使用

使用技術

技術名称	使用用途
Python	バックエンドの処理
SQLite3	データの保存
HTML	フロントエンドの構造全般
JavaScript	フロントエンドの処理全般
CSS	フロントエンドのデザイン全般

使用モジュールのリファレンスリンク

パッケージ	バージョン	公式リファレンスページ
APScheduler	3.10.1	APScheduler
arrow	1.2.3	Arrow
asgiref	3.7.2	asgiref
attrs	23.1.0	attrs
blinker	1.6.2	blinker
cachetools	5.3.0	cachetools
certifi	2023.5.7	certifi
chardet	4.0.0	chardet
charset-normalizer	3.1.0	charset-normalizer
click	8.1.3	Click
crypto	1.4.1	python-crypto
Django	4.2.3	Django
django-scheduler	0.10.1	django-scheduler
Flask	2.3.2	Flask
Flask-BasicAuth	0.2.0	Flask-BasicAuth
Flask-Dance	7.0.0	Flask-Dance
Flask-HTTPAuth	4.8.0	Flask-HTTPAuth
google-api-core	2.11.0	google-api-core
google-api-python-client	2.86.0	google-api-python-client
google-auth	2.18.1	google-auth
google-auth-httplib2	0.1.0	google-auth-httplib2
google-auth-oauthlib	1.0.0	google-auth-oauthlib
googleapis-common-protos	1.59.0	googleapis-common-protos
httplib2	0.22.0	httplib2
icalendar	5.0.7	icalendar
ics	0.7.2	ics
idna	2.10	idna
itsdangerous	2.1.2	itsdangerous
Jinja2	3.1.2	Jinja2
joblib	1.3.2	joblib
Levenshtein	0.21.0	python-Levenshtein
Markdown	3.4.3	Markdown
MarkupSafe	2.1.2	MarkupSafe
Naked	0.1.32	Naked
ngrok-api	0.10.0	ngrok-api
nltk	3.8.1	NLTK
numpy	1.26.0	NumPy
oauthlib	3.2.2	oauthlib
Pillow	9.5.0	Pillow
protobuf	4.23.1	protobuf
pyasn1	0.5.0	pyasn1
pyasn1-modules	0.3.0	pyasn1-modules
pyparsing	3.0.9	pyparsing
pypng	0.20220715.0	pypng
python-barcode	0.14.0	python-barcode
python-dateutil	2.8.2	python-dateutil
python-Levenshtein	0.21.0	python-Levenshtein
pytz	2023.3	pytz
PyYAML	6.0	PyYAML
qrcode	7.4.2	qrcode
rapidfuzz	3.0.0	rapidfuzz
regex	2023.8.8	regex
requests	2.25.1	requests
requests-oauthlib	1.3.1	requests-oauthlib
romkan	0.2.1	romkan
rsa	4.9	rsa
scikit-learn	1.3.0	scikit-learn
scipy	1.11.2	SciPy
shellescape	3.8.1	shellescape
six	1.16.0	six
sqlparse	0.4.4	sqlparse
TatSu	5.8.3	TatSu
threadpoolctl	3.2.0	threadpoolctl
tqdm	4.66.1	tqdm
typing_extensions	4.8.0	typing-extensions
tzlocal	5.0.1	tzlocal
uritemplate	4.1.1	uritemplate
urllib3	1.26.15	urllib3
URLObject	2.4.3	URLObject
Werkzeug	2.3.4	Werkzeug

利用

メニューバー

各種メニュー(上から順）

• トップページ
• アカウント
• 検索
• 貸出
• 返却
• 新本登録
• 棚卸し
• Info

バックグラウンドイメージ変更

好きな背景色を選択することができます。
Cookieを使用してページ推移をしてもカラーを維持できるようになっています。

headerの各メニューについて

トップページ

機能

新しく購入した本を３冊紹介しています
紹介中の本をクリックするとほんの詳細ページへ移動できます。

アカウントページ

機能

制作済みのアカウントでログインをしたり、アカウントの情報を更新するためのページです。

アカウント作成ページ

機能

新規でアカウントを登録するためのページです。
You Tubeにアカウントの作り方を詳細に説明した動画がアップロードされています。

パスワードのリセットページ

機能

パスワードやそもそもユーザーIDを忘れてしまった場合にでもすぐに解決できるようにパスワードのリセットページが設けてあります。

本の検索ページ

機能

本の検索をするためのページです
デフォルトでは本のタイトルのみの検索ですがチェックマークを入れることで関連ワードなどから検索をすることができます
また、ISBNやバーコードから本を検索することが可能となります。
サジェスト機能を導入することでいち早く探している本を見つけることが可能になっています。

以下が本の検索の例です!

実際にアクセスして違いを確認してみてください

本のタイトルのみの絞り込みで”日本一”で検索
関連キーワードも含む絞り込みで”日本一”で検索
ISBNで検索
特殊コマンド(貸出中の本を絞り込む)

本の貸出ページ

機能　

本の裏にあるバーコードを手入力または、バーコードリーダーまたは、WEBカメラ入力で読み込むことができます。
貸出ボタンを押すことでログイン中のアカウントで本を借りることができます。

本の返却ページ

機能　

貸出時に付与された返却コードを読み込むことで本の返却ができます。
また、メールに貸出時に送信されているQRコードを用いてWEBカメラで読み取り本を返却することができます。
貸出時にICSファイル（カレンダーファイル）が自動生成されて送付されているので返却忘れを防ぐことが可能になっています。

新本登録ページページ

機能

キャンパス図書に新しく追加した本を登録します。
管理番号は、キャンパスで印刷したバーコードのコードを登録します。
本の情報に関してはGoogleBooksAPIを使用して、情報を取得し、自動で入力（結果がない場合のみ、手動で入力）するようになっています。
取得する情報は以下のとおりです
→ISBNを入力
Response:

• タイトル
• 著者
• ヘッダー文章
• サンプル画像URL
• ページ数
• 公開日

GoogleBooksAPIを使用することによって入力のミスなどを減らすことができるようになりました。

棚卸しページ

機能

このページでは棚卸しを行うことができます。
年に一度図書委員会では、蔵書されている本が、今も本棚にあるかどうかを確認するためにすべての本のバーコードを読み取り、データの整合性が取れているのかを確認します。
すべてのスキャンが終了したら、以下のようなCSVデータをダウンロードすることができます。

ID,管理コード,ISBNコード,書籍名,蔵書状況
1,10000013,9784781651033,福岡はすごい,在庫確認
2,10000020,9784121022820,地方消滅,在庫不足
3,10000107,9784052051715,なぜ僕らは働くのか,在庫確認
4,10000008,9784062200172,ミライの授業,在庫あり
5,10000209,9784844365174,なるほどデザイン,在庫不足
6,10000007,9784838729470,漫画君たちはどう生きるか,在庫不足
7,10000068,9784478470886,餃子屋と高級フレンチでは、どちらが儲かるか?,在庫不足
8,10000088,9784344033597,いま君に伝えたいお金の話,在庫不足
9,10000006,9784479393245,僕らが生きているよのなかのしくみは「法」でわかる,在庫確認
10,10000441,9784335357923,こども六法,在庫不足
11,10000041,9784794969552,11歳からの正しく怖がるインターネット,在庫確認
12,10000057,9784865014228,岩田さん　岩田聡はこんなことを話していた。,在庫不足
13,10000063,9784763135667,「孤独」は消せる。,在庫確認
14,10000061,9784866630625,サイボーグ時代,在庫確認
15,10000042,9784040642734,ありのままに生きてます,在庫不足
16,10000001,9784478105870,プレゼン資料のデザイン図鑑,在庫確認
17,10000054,9784775311073,ストーリーの作り方,在庫不足
18,10000052,9784297105129,ゲームプランナー入門アイデア・企画書・仕様書の技術から就職まで,在庫確認
19,10000050,9784862464149,クリエイターのための権利の本,在庫確認
20,10000028,9784062206624,デザインの仕事,在庫確認

infoページ

機能

このページではヘルプページへのアクセスや貸出ランキングの表示などをしています。

上級管理メニュー

上級の管理メニュー　主にシステム自体の設定を開くには、Digest認証をクリアした後、図書管理システムのユーザー登録でアクセス権限レベル4以上の場合のみアクセスができるようになっています。

今回は以下のメニューに付いて可能な限り説明したいと思います。

DB操作ログ

この機能は、データベースへの操作を行った際に、どのユーザーがなんの操作をしたのかを記録します。
履歴には保存等級を1-3でつけ

1 - 1ヶ月保存  (ユーザーのログインやメール送信など)
2 - 1年保存   （パスワードリセットのリクエストや本の貸出など）
3 - 永久保存   （アカウントの作成や本の登録・削除など）

の形で分けています。

また、絞り込み機能を取り付けて以下のような項目を組み合わせてログを特定しやすくなっています。
-　範囲検索（開始日付：終了日付)
-　保存等級　(1〜3)
-　フリーワード　（”削除”などのワード）

ログを残すことで、エラーが起きた際に原因を早急に見つけることが可能になります。

ユーザー管理

この機能ではアカウント登録をしているユーザーを一覧で確認することができます。
この機能から直接ポイント操作を行ったり、ユーザーに対してメールを送信する事ができるようになっています。
利用用途としては、ポイントデータの訂正や、GoogleFormsから問い合わせいただいた内容を返信する場合に使用することを考えています。

貸出管理

この機能ではどのユーザーがなんの本をいつ借りたのかを確認することができます。
また、手動で貸出状態を返却済みの状態に変更したり、または逆のことをすることができるようになっています。
利用用途としては、誤って返却してしまった場合に貸出状態に復元をしてあげることが可能になります。

蔵書管理と本の情報更新

この機能では蔵書している本のデータを更新したり、追加したり削除したりすることができるようになっています。
現在は300冊前後が蔵書されています。
本のタイトルなどを誤って登録していた場合などに訂正をすることができます。
また、廃書になった場合に削除をすることができます。

システムログ

この機能では、Flaskが出力するログを保存しているfileをダウンロードすることができます。
実際に以下のようなデータが保存されています。

 * Running on all addresses (0.0.0.0)
 * Running on http://127.0.0.1:54321
 * Running on http://10.7.100.81:54321
2023-12-08 10:15:18,555 - werkzeug - INFO - [33mPress CTRL+C to quit[0m
2023-12-08 10:15:20,129 - pyngrok.process.ngrok - INFO - t=2023-12-08T10:15:20+0900 lvl=info msg="join connections" obj=join id=55860bbbf481 l=127.0.0.1:54321 r=125.103.68.146:53300
2023-12-08 10:15:20,133 - main - INFO - 127.0.0.1
2023-12-08 10:15:20,133 - main - INFO - 127.0.0.1/32
2023-12-08 10:15:20,141 - werkzeug - INFO - 127.0.0.1 - - [08/Dec/2023 10:15:20] "GET /account HTTP/1.1" 200 -
2023-12-08 10:15:20,187 - pyngrok.process.ngrok - INFO - t=2023-12-08T10:15:20+0900 lvl=info msg="update available" obj=updater
2023-12-08 10:15:20,224 - pyngrok.process.ngrok - INFO - t=2023-12-08T10:15:20+0900 lvl=info msg="join connections" obj=join id=b7569c1bac6c l=127.0.0.1:54321 r=125.103.68.146:53300
2023-12-08 10:15:20,224 - pyngrok.process.ngrok - INFO - t=2023-12-08T10:15:20+0900 lvl=info msg="join connections" obj=join id=22f0e89e8e7b l=127.0.0.1:54321 r=125.103.68.146:53300
2023-12-08 10:15:20,227 - main - INFO - 127.0.0.1
2023-12-08 10:15:20,228 - main - INFO - 127.0.0.1
2023-12-08 10:15:20,228 - main - INFO - 127.0.0.1/32
2023-12-08 10:15:20,228 - main - INFO - 127.0.0.1/32

Flaskが出力するログを確認することで、システムの詳細エラーを確認し、システムの改善につなげることが可能となります。

エラー設定

この機能では、エラーページに出力するエラーの内容を確認・変更することができるようになっています。
案内方法に変更があった際に速やかに反映させることができるようになります。

メンテナンス・データベースバックアップ

この機能では、システムのメンテナンスやデータベースのフルバックアップを行うことができます。
定期的にメンテナンスを行うことで、不要なログデータを削除したり、処理漏れする可能性があるデータのクリーンアップをすることができます。

データベースのバックアップを取ることで、データが紛失する可能性を減らすことが可能になります。

セキュリティのお話

• ユーザーのアカウント登録時に、パスワードはランダムなソルトと連結した状態でSHA-512のハッシュ化をされています。

• アカウントログイン試行回数が記録されており、パスワードを5回間違えると、パスワードのリセットをしないとログインできなくなるように成っています。※画像１

• 上級管理メニューはDigest認証が実装されており、固有のユーザーIDとパスワードを知らないと入ることができなくなっています。　※画像2

• 全てのページに置いてIPアドレスによるフィルタリングを実施しており、指定されたIPアドレス以外からのアクセスは、全てブロックすることができます。※画像3/4

補足

ip_gps_data.jsonの値に以下の値を追加するとIPフィルタリングを無効化することができます。

  "ip_host3": [
    "999.99.999",
    "aaa.bbb.ccc.ddd"
  ]

システムアップデート

システムアップデート配信サーバーから配信されるデータとシステムバージョンを比較してアップデートがあるシステムファイルのアップデートを行います。

{
  "next_url": "https://raw.githubusercontent.com/MT472562/Library_Tool_Ver3_Update_Server/main/",
  "version_data": "https://raw.githubusercontent.com/MT472562/Library_Tool_Ver3_Update_Server/main/system_version.json",
  "SystemVersion": 1.1,
  "spare": "spare",
  "spare": "spare",
  "make_directory": [],
  "main.py": 1.1,
  "Maintenance.py": 1.0,
  "database_reset.py": 1.0,
  "Install_check.py": 1.0,
  "templates/resources/css/base.css": 1.1,
  "templates/resources/css/style.css": 1.0,
  ".......その他システム構成ファイル"
}

プロジェクトを通して

色々なプロジェクトを同時並行しながらで、なんやかんやで１年近くここに来るまで時間がかかったけれども、今はRaspberryPiにデプロイして自分の卒業制作として、キャンパスに残していければいいな。。と思っています。