サンプルを見る
📖 この記事のゴール
目標
(会員登録ユーザーではなく)現在、サーバーに接続されていると思われるユーザー(≒アクティブ・ユーザー)を一覧したい
- ログインしたまま サーバーから離れていて、まだセッション期限切れをしていないユーザーを数えてしまっても構わないものとする
情報
この記事は Lesson 1. から順に全部やってこないと ソースが足りず実行できないので注意されたい
What is | This is |
---|---|
Lesson 1. | 📖 DjangoとDockerでゲーム対局サーバーを作ろう! |
この記事のアーキテクチャ:
What is | This is |
---|---|
OS | Windows10 |
Container | Docker |
Auth | allauth |
Editor | Visual Studio Code (以下 VSCode と表記) |
ディレクトリ構成を抜粋すると 以下のようになっている
├── 📂 src1
│ ├── 📂 apps1
│ │ ├── 📂 accounts_vol1o0 # アプリケーション
│ │ ├── 📂 portal_v1 # アプリケーション
│ │ └── 📂 practice_vol1o0 # アプリケーション
│ ├── 📂 data
│ ├── 📂 project1 # プロジェクト
│ │ ├── 📄 __init__.py
│ │ ├── 📄 asgi.py
│ │ ├── 📄 settings_secrets_example.txt
│ │ ├── 📄 settings.py
│ │ ├── 📄 urls_accounts_vol1o0.py
│ │ ├── 📄 urls_practice.py
│ │ ├── 📄 urls.py
│ │ └── 📄 wsgi.py
│ ├── 📂 project2
│ ├── 🐳 docker-compose-project2.yml
│ ├── 🐳 docker-compose.yml
│ ├── 🐳 Dockerfile
│ ├── 📄 manage.py
│ └── 📄 requirements.txt
├── 📂 src1_meta
│ ├── 📂 data
│ │ └── 📄 urls.csv
│ └── 📂 scripts
│ └── 📂 auto_generators
│ └── 📄 urls.py
└── 📄 .gitignore
手順
Step O9o3o0g1o0 Dockerコンテナの起動
👇 (していなければ) Docker コンテナを起動しておいてほしい
# docker-compose.yml ファイルを置いてあるディレクトリーへ移動してほしい
cd src1
# Docker コンテナ起動
docker-compose up
Step O9o3o0g2o0 画面作成 - active_user_list/ver1o0.html ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
└── 📂 templates
└── 📂 practice_vol1o0 # アプリケーションと同名
└── 📂 active_user_list
👉 └── 📄 ver1o0.html
{# O9o3o0g2o0 #}
<!-- -->
{% load static %} {# 👈 あとで static "URL" を使うので load static します #}
<!DOCTYPE html>
<!-- See also: https://qiita.com/zaburo/items/ab7f0eeeaec0e60d6b92 -->
<html lang="ja">
<head>
<meta charset="utf-8" />
<link rel="shortcut icon" type="image/png" href="{% static 'favicon.ico' %}" />
<link href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900" rel="stylesheet" />
<link href="https://cdn.jsdelivr.net/npm/@mdi/font@6.x/css/materialdesignicons.min.css" rel="stylesheet" />
<link href="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.min.css" rel="stylesheet" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>アクティブ ユーザー一覧</title>
</head>
<body>
<div id="app">
<v-app>
<v-main>
<v-container>
<h3>アクティブ ユーザー一覧</h3>
</v-container>
<v-container>
<v-simple-table>
<template v-slot:default>
<thead>
<tr>
<th>ID</th>
<th>ユーザー名</th>
<th>アクティブか</th>
<th>最終ログイン</th>
</tr>
</thead>
<tbody>
<tr v-for="user in vu_users" :key="user.pk">
{% comment %} Vue で二重波括弧(braces)は変数の展開に使っていることから、 Python のテンプレートに二重波括弧を変数の展開に使わないよう verbatim で指示します。 {% endcomment %} {% verbatim %}
<td>{{ user.pk }}</td>
<td>{{ user.username }}</td>
<td>{{ user.is_active }}</td>
<td>{{ user.last_login }}</td>
{% endverbatim %}
</tr>
</tbody>
</template>
</v-simple-table>
</v-container>
</v-main>
</v-app>
</div>
<script src="https://cdn.jsdelivr.net/npm/vue@2.x/dist/vue.js"></script>
<script src="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.js"></script>
<script>
let vue1 = new Vue({
el: "#app",
vuetify: new Vuetify(),
data: {
// "vu_" は 「vue1.dataのメンバー」 の目印
vu_users: JSON.parse("{{ dj_users|escapejs }}"),
},
methods: {
createRoomsReadPath(id) {
return `${this.vu_readRoomPath}${id}`;
},
},
});
</script>
</body>
</html>
Step O9o3o0g3o0 モデル関連作成 - session/ver1o0 フォルダー
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 session
│ └── 📂 ver1o0
👉 │ └── 📄 __init__.py
└── 📂 templates
└── 📂 practice_vol1o0 # アプリケーションと同名
└── 📂 active_user_list
└── 📄 ver1o0.html
class MhSession():
"""O9o3o0g3o0 練習1.0巻 セッション ヘルパー1.0版"""
# O9o3o0g3o0 以下のファイルはあとで作ります
from .v_get_all_logged_in_users import get_all_logged_in_users
# -------------------------- -----------------------
# 1 2
# 1. `src1/apps1/practice_vol1o0/model_helper/sesion/ver1o0/v_get_all_logged_in_users.py`
# -------------------------
# 2. `1.` に含まれる関数
Step O9o3o0g4o0 ビュー作成 - session/ver1o0/v_get_all_logged_in_users.py ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 session
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
👉 │ └── 📄 v_get_all_logged_in_users.py
└── 📂 templates
└── 📂 practice_vol1o0 # アプリケーションと同名
└── 📂 active_user_list
└── 📄 ver1o0.html
# See also: 📖[How to get the list of the authenticated users?](https://stackoverflow.com/questions/2723052/how-to-get-the-list-of-the-authenticated-users)
from django.contrib.auth.models import User
from django.contrib.sessions.models import Session
from django.utils import timezone
def get_all_logged_in_users():
"""O9o3o0g4o0 接続が切れていないセッションを絞りこみます。
ログアウトせず2週間放置しているセッションが含まれる場合があります
"""
sessions = Session.objects.filter(expire_date__gte=timezone.now())
uid_list = []
# セッション一覧を、ユーザーID一覧に変換します
for session in sessions:
data = session.get_decoded()
uid_list.append(data.get('_auth_user_id', None))
user_resultset = User.objects.filter(id__in=uid_list)
"""
web_1 | user_table_doc=[
web_1 | {
web_1 | "model": "auth.user",
web_1 | "pk": 1,
web_1 | "fields": {
web_1 | "password": "pbkdf2_sha256$260000$tOSdFO6BqvafBgtFgE1qYS$+rv007MKnAy8j+krixlQuogvi46Xl8fZf87xn4lAU+0=",
web_1 | "last_login": "2022-05-14T03:09:21.968Z",
web_1 | "is_superuser": false,
web_1 | "username": "kifuwarabe",
web_1 | "first_name": "",
web_1 | "last_name": "",
web_1 | "email": "muzudho1@gmail.com",
web_1 | "is_staff": false,
web_1 | "is_active": true,
web_1 | "date_joined": "2022-03-13T05:45:26.368Z",
web_1 | "groups": [],
web_1 | "user_permissions": []
web_1 | }
web_1 | }
web_1 | ]
"""
# print(f"user_table_doc={json.dumps(user_table_doc, indent=4)}")
# 使いやすい形に変換します
user_dic = dict()
for user in user_resultset:
if user.last_login is None:
# まだ一度もログインしていないとき
last_login1 = ""
else:
# 日付型はJSONに変換できないので、先に文字列に変換しておく
last_login1 = user.last_login.strftime("%Y-%m-%d %H:%M:%S")
user_dic[user.pk] = {
"pk": user.pk,
"last_login": last_login1,
"username": user.username,
"is_active": user.is_active,
}
return user_dic
Step O9o3o0g5o0 ビュー作成 - session/ver1o0 フォルダー
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 session
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 v_get_all_logged_in_users.py
├── 📂 templates
│ └── 📂 practice_vol1o0
│ └── 📂 active_user_list
│ └── 📄 ver1o0.html
└── 📂 views
└── 📂 session
└── 📂 ver1o0
👉 └── 📄 __init__.py
class SessionV():
"""O9o3o0g5o0 練習1.0巻 セッション1.0版"""
# このページ
_path_of_this_page = "practice_vol1o0/active_user_list/ver1o0.html"
# --------------------------------------------
# 1
# 1. `src1/apps1/practice_vol1o0/templates/practice_vol1o0/active_user_list/ver1o0.html` を取得
# --------------------------------------------
@staticmethod
def render(request):
"""O9o3o0g5o0 練習1.0巻 セッション1.0版 - 描画"""
# 以下のファイルはあとで作ります
from .v_render import render_active_user_list
# --------- -----------------------
# 1 2
# 1. `src1/apps1/practice_vol1o0/views/session/ver1o0/v_render.py`
# --------
# 2. `1.` に含まれる関数
return render_active_user_list(request, SessionV._path_of_this_page)
Step O9o3o0g6o0 ビュー作成 - session/v_render.py ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 session
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 v_get_all_logged_in_users.py
├── 📂 templates
│ └── 📂 practice_vol1o0
│ └── 📂 active_user_list
│ └── 📄 ver1o0.html
└── 📂 views
└── 📂 session
└── 📂 ver1o0
├── 📄 __init__.py
👉 └── 📄 v_render.py
import json
from django.shortcuts import render
# 練習1.0巻 セッション モデルヘルパー1.0版
from apps1.practice_vol1o0.models_helper.session.ver1o0 import MhSession
# --------------- ------ ---------
# 11 12 2
# --------------------------------------------------
# 10
# 10, 12. ディレクトリー
# 11. アプリケーション
# 2. クラス
def render_active_user_list(request, path_of_this_page):
"""O9o3o0g6o0 練習1.0巻 アクティブ ユーザー一覧1.0版 - 描画"""
context = {
# * `dj_` - 「Djangoがレンダーに埋め込む変数」 の目印
# * Vue に渡すときは、 JSON オブジェクトではなく、 JSON 文字列
'dj_users': json.dumps(MhSession.get_all_logged_in_users())
}
return render(request, path_of_this_page, context)
Step O9o3o0g7o0
Merged to O9o3o0g7o1o0
Step O9o3o0g7o1o0 ルート編集 - urls.csv ファイル
👇 以下の既存ファイルの末尾に追記してほしい
├── 📂 src1
│ └── 📂 apps1
│ └── 📂 practice_vol1o0 # アプリケーション
│ ├── 📂 models_helper
│ │ └── 📂 session
│ │ └── 📂 ver1o0
│ │ ├── 📄 __init__.py
│ │ └── 📄 v_get_all_logged_in_users.py
│ ├── 📂 templates
│ │ └── 📂 practice_vol1o0
│ │ └── 📂 active_user_list
│ │ └── 📄 ver1o0.html
│ └── 📂 views
│ └── 📂 o1o0
│ └── 📂 session
│ ├── 📄 __init__.py
│ └── 📄 v_render_active_user_list.py
└── 📂 src1_meta
└── 📂 data
👉 └── 📄 urls.csv
...略... file,path,name,comment,module,class,alias,method
...略...
../src1/project1/urls_practice_vol1o0_autogen.py,practice/vol1.0/active-user-list/ver1.0/,,"O9o3o0g7o1o0 練習1.0巻 アクティブユーザー一覧1.0版",apps1.practice_vol1o0.views.session.ver1o0,SessionV,,render
Step O9o3o0g7o2o0 ルート編集 - コマンド打鍵
👇 以下のコマンドを打鍵してほしい
cd ../src1_meta
python -m scripts.auto_generators.urls
cd ../src1
docker-compose restart
- ディレクトリーは、がんばって移動してほしい
- スクリプトについて See also: O3o2o_1o0g2o0
- 設定ファイルを変更したら、サーバーの再起動が必要
Step O9o3o0g8o0 Web画面へアクセス
📖 http://localhost:8000/practice/vol1.0/active-user-list/ver1.0/
Step O9o3o0g9o0 ランチャーのリンク用データ追加 - finished-lessons.csv ファイル
👇 以下の既存ファイルの最終行に追記してほしい
└── 📂 src1
├── 📂 apps1
│ ├── 📂 portal_v1 # アプリケーション
│ │ └── 📂 data
👉 │ │ └── 📄 finished-lessons.csv
│ └── 📂 practice_vol1o0 # アプリケーション
│ ├── 📂 models_helper
│ │ └── 📂 session
│ │ └── 📂 ver1o0
│ │ ├── 📄 __init__.py
│ │ └── 📄 v_get_all_logged_in_users.py
│ ├── 📂 templates
│ │ └── 📂 practice_vol1o0
│ │ └── 📂 active_user_list
│ │ └── 📄 ver1o0.html
│ └── 📂 views
│ └── 📂 session
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 v_render_active_user_list.py
└── 📂 project1 # プロジェクト
└── 📄 urls_practice.py
👇 冗長なスペース,冗長なダブルクォーテーション,末尾のカンマ は止めてほしい
/practice/vol1.0/active-user-list/ver1.0/,O9o3o0g9o0 練習1.0巻 アクティブユーザー一覧1.0版
👇 ランチャーにリンクが追加されていることを確認してほしい
次の記事
関連する記事
📖 djangoでログイン状態を判定する機能
📖 How to get the list of the authenticated users?
📖 Get List of Current Users