18 |
19 |
20 |
--------------------------------------------------------------------------------
/scripts/README.md:
--------------------------------------------------------------------------------
1 | Scripts
2 | =====
3 |
4 | Scripts are code that performs automated tasks to NPPS4 itself.
5 |
6 | To run the scripts directly like ordinary Python scripts, run this once in virtual environment:
7 | ```
8 | pip install -e .
9 | ```
10 |
11 | Then you can run them like ordinary scripts (e.g. `python script.py ...`)
12 |
13 | If you don't want to do `pip install -e .`, then to run script, you must run it like this:
14 | ```
15 | python -m npps4.script script.py ...
16 | ```
17 |
18 | Will run `script.py` in the working directory.
19 |
--------------------------------------------------------------------------------
/npps4/system/scenario_model.py:
--------------------------------------------------------------------------------
1 | import pydantic
2 |
3 | from . import item_model
4 | from .. import const
5 |
6 |
7 | class AdditionalScenarioStatus(pydantic.BaseModel):
8 | scenario_id: int
9 | status: int = 1
10 |
11 |
12 | class ScenarioItem(item_model.Item):
13 | add_type: const.ADD_TYPE = const.ADD_TYPE.SCENARIO
14 | amount: int = 1
15 |
16 | @pydantic.computed_field
17 | @property
18 | def additional_scenario_status(self) -> AdditionalScenarioStatus:
19 | return AdditionalScenarioStatus(scenario_id=self.item_id)
20 |
--------------------------------------------------------------------------------
/util/leaderskill_db_map.txt:
--------------------------------------------------------------------------------
1 | SELECT * FROM 'unit_leader_skill_m'
2 | SELECT * FROM 'unit_leader_skill_extra_m'
3 |
4 | Note: Leader skill affects all teams!
5 |
6 | Leader skill calc:
7 |
8 | * leader_skill_effect_type
9 | 1 = +Smile
10 | 2 = +Pure
11 | 3 = +Cool
12 | 112 = +Pure by Smile
13 | 113 = +Cool by Smile
14 | 121 = +Smile by Pure
15 | 123 = +Cool by Pure
16 | 131 = +Smile by Cool
17 | 132 = +Pure by Cool
18 |
19 | Extra leader skill calc:
20 |
21 | * member_tag_id = member_tag_id in member_tag_m
22 | * leader_skill_effect_type = same as above
23 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import os.path
2 | import setuptools # type: ignore
3 |
4 | import npps4.version
5 |
6 | with open(os.path.join(os.path.dirname(__file__), "requirements.txt"), "r", encoding="utf-8") as f:
7 | setuptools.setup(
8 | name="npps4",
9 | version="%d.%d.%d" % npps4.version.NPPS4_VERSION,
10 | description="Null-Pointer Private Server",
11 | author="Miku AuahDark",
12 | packages=["npps4"],
13 | install_requires=["wheel", *map(str.strip, f)],
14 | entry_points={"console_scripts": ["npps4_script=npps4.script:entry"]},
15 | )
16 |
--------------------------------------------------------------------------------
/scripts/update_server_data_json_schema.py:
--------------------------------------------------------------------------------
1 | import json
2 |
3 | import npps4.script_dummy # isort:skip
4 | import npps4.data.schema
5 |
6 |
7 | async def run_script(args: list[str]):
8 | schema = npps4.data.schema.SerializedServerData.model_json_schema()
9 | schema["$schema"] = "https://json-schema.org/draft/2020-12/schema"
10 | with open("npps4/server_data_schema.json", "w", encoding="utf-8", newline="") as f:
11 | json.dump(schema, f, indent="\t")
12 |
13 |
14 | if __name__ == "__main__":
15 | import npps4.scriptutils.boot
16 |
17 | npps4.scriptutils.boot.start(run_script)
18 |
--------------------------------------------------------------------------------
/npps4/system/tos.py:
--------------------------------------------------------------------------------
1 | import sqlalchemy
2 |
3 | from .. import idol
4 | from ..db import main
5 |
6 |
7 | async def is_agreed(context: idol.SchoolIdolParams, user: main.User, tos_id: int):
8 | q = sqlalchemy.select(main.TOSAgree).where(main.TOSAgree.user_id == user.id, main.TOSAgree.tos_id == tos_id)
9 | result = await context.db.main.execute(q)
10 | return result.scalar() is not None
11 |
12 |
13 | async def agree(context: idol.BasicSchoolIdolContext, user: main.User, tos_id: int):
14 | agree = main.TOSAgree(user_id=user.id, tos_id=tos_id)
15 | context.db.main.add(agree)
16 | await context.db.main.flush()
17 |
--------------------------------------------------------------------------------
/npps4/game/announce.py:
--------------------------------------------------------------------------------
1 | from .. import idol
2 | from ..system import common
3 | from ..system import reward
4 | from ..system import user
5 |
6 |
7 | class AnnounceStateResponse(common.TimestampMixin):
8 | present_cnt: int
9 | has_unread_announce: bool
10 |
11 |
12 | @idol.register("announce", "checkState")
13 | async def announce_checkstate(context: idol.SchoolIdolUserParams) -> AnnounceStateResponse:
14 | current_user = await user.get_current(context)
15 | return AnnounceStateResponse(
16 | present_cnt=await reward.count_presentbox(context, current_user),
17 | has_unread_announce=False, # TODO
18 | )
19 |
--------------------------------------------------------------------------------
/scripts/list_users.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python -m npps4.script
2 | import sqlalchemy
3 |
4 | import npps4.db.main
5 | import npps4.idol
6 |
7 |
8 | async def run_script(args: list[str]):
9 | context = npps4.idol.BasicSchoolIdolContext(lang=npps4.idol.Language.en)
10 | async with context:
11 | q = sqlalchemy.select(npps4.db.main.User)
12 | result = await context.db.main.execute(q)
13 | for user in result.scalars():
14 | print(f"{user.id}|{user.name}|{user.invite_code}")
15 |
16 |
17 | if __name__ == "__main__":
18 | import npps4.scriptutils.boot
19 |
20 | npps4.scriptutils.boot.start(run_script)
21 |
--------------------------------------------------------------------------------
/npps4/webui/endpoints/list_users.py:
--------------------------------------------------------------------------------
1 | import fastapi
2 | import sqlalchemy
3 |
4 | from .. import template
5 | from ... import idol
6 | from ...app import webui
7 | from ...db import main
8 |
9 |
10 | @webui.app.get("/list_users.html")
11 | async def list_users(request: fastapi.Request):
12 | async with idol.BasicSchoolIdolContext(lang=idol.Language.en) as context:
13 | q = sqlalchemy.select(main.User)
14 | result = await context.db.main.execute(q)
15 | users = [{"name": user.name, "id": user.id} for user in result.scalars()]
16 |
17 | return template.template.TemplateResponse(request, "list_users.html", {"users": users})
18 |
--------------------------------------------------------------------------------
/npps4/game/personalnotice.py:
--------------------------------------------------------------------------------
1 | import pydantic
2 |
3 | from .. import idol
4 | from .. import util
5 |
6 |
7 | class PersonalNoticeGetResponse(pydantic.BaseModel):
8 | has_notice: bool
9 | notice_id: int
10 | type: int
11 | title: str
12 | contents: str
13 |
14 |
15 | @idol.register("personalnotice", "get")
16 | async def personalnotice_get(context: idol.SchoolIdolUserParams) -> PersonalNoticeGetResponse:
17 | # https://github.com/DarkEnergyProcessor/NPPS/blob/v3.1.x/modules/personalnotice/get.php
18 | # TODO
19 | util.stub("personalnotice", "get", context.raw_request_data)
20 | return PersonalNoticeGetResponse(has_notice=False, notice_id=0, type=0, title="", contents="")
21 |
--------------------------------------------------------------------------------
/scripts/generate_hashed_serialcode.py:
--------------------------------------------------------------------------------
1 | import base64
2 | import hashlib
3 | import json
4 | import secrets
5 | import sys
6 |
7 |
8 | def main(args: list[str]):
9 | sysrand = secrets.SystemRandom()
10 | for serial_code in args:
11 | salt = sysrand.randbytes(16)
12 | serial_code_bytes = serial_code.encode("utf-8")
13 | digest = hashlib.sha256(salt + serial_code_bytes, usedforsecurity=False)
14 | result = json.dumps({"hash": digest.hexdigest(), "salt": str(base64.urlsafe_b64encode(salt), "utf-8")})
15 | print(f"{serial_code}: {result}")
16 |
17 |
18 | async def run_script(args: list[str]):
19 | main(args)
20 |
21 |
22 | if __name__ == "__main__":
23 | main(sys.argv[1:])
24 |
--------------------------------------------------------------------------------
/npps4/idoltype.py:
--------------------------------------------------------------------------------
1 | import enum
2 |
3 | import pydantic
4 |
5 |
6 | class Language(str, enum.Enum):
7 | en = "en"
8 | jp = "jp"
9 |
10 |
11 | class PlatformType(enum.IntEnum):
12 | iOS = 1
13 | Android = 2
14 |
15 |
16 | class XMCVerifyMode(enum.IntEnum):
17 | NONE = 0
18 | SHARED = 1
19 | CROSS = 2
20 |
21 |
22 | class ReleaseInfoData(pydantic.BaseModel):
23 | id: int
24 | key: str
25 |
26 |
27 | class ResponseData[_S: pydantic.BaseModel](pydantic.BaseModel):
28 | response_data: _S
29 | release_info: list[ReleaseInfoData] = pydantic.Field(default_factory=list)
30 | status_code: int = 200
31 |
32 |
33 | class ErrorResponse(pydantic.BaseModel):
34 | error_code: int
35 | detail: str | None
36 |
--------------------------------------------------------------------------------
/npps4/alembic/script.py.mako:
--------------------------------------------------------------------------------
1 | """${message}
2 |
3 | Revision ID: ${up_revision}
4 | Revises: ${down_revision | comma,n}
5 | Create Date: ${create_date}
6 |
7 | """
8 | from typing import Sequence, Union
9 |
10 | from alembic import op
11 | import sqlalchemy as sa
12 | ${imports if imports else ""}
13 |
14 | # revision identifiers, used by Alembic.
15 | revision: str = ${repr(up_revision)}
16 | down_revision: Union[str, None] = ${repr(down_revision)}
17 | branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
18 | depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
19 |
20 |
21 | def upgrade() -> None:
22 | ${upgrades if upgrades else "pass"}
23 |
24 |
25 | def downgrade() -> None:
26 | ${downgrades if downgrades else "pass"}
27 |
--------------------------------------------------------------------------------
/npps4/alembic/versions/2024_07_07_1728-eaefd67367c8_wal.py:
--------------------------------------------------------------------------------
1 | """wal
2 |
3 | Revision ID: eaefd67367c8
4 | Revises: 1d73d9b010d0
5 | Create Date: 2024-07-07 17:28:38.375308
6 |
7 | """
8 |
9 | from typing import Sequence, Union
10 |
11 | from alembic import op
12 |
13 |
14 | # revision identifiers, used by Alembic.
15 | revision: str = "eaefd67367c8"
16 | down_revision: Union[str, None] = "1d73d9b010d0"
17 | branch_labels: Union[str, Sequence[str], None] = None
18 | depends_on: Union[str, Sequence[str], None] = None
19 |
20 |
21 | def upgrade() -> None:
22 | if op.get_bind().engine.name.startswith("sqlite"):
23 | op.execute("PRAGMA journal_mode=WAL;")
24 |
25 |
26 | def downgrade() -> None:
27 | if op.get_bind().engine.name.startswith("sqlite"):
28 | op.execute("PRAGMA journal_mode=DELETE;")
29 |
--------------------------------------------------------------------------------
/npps4/script.py:
--------------------------------------------------------------------------------
1 | import argparse
2 | import asyncio
3 |
4 | from . import evloop
5 | from . import script_dummy
6 | from .config import config
7 |
8 | from typing import Protocol
9 |
10 |
11 | class Script(Protocol):
12 | async def run_script(self, args: list[str]): ...
13 |
14 |
15 | def load_script(path: str):
16 | return config.load_module_from_file(path, "npps4_script_run")
17 |
18 |
19 | async def main():
20 | parser = argparse.ArgumentParser()
21 | parser.add_argument("script", type=load_script, help="Script to run.")
22 |
23 | args, unk_args = parser.parse_known_args()
24 | script: Script = args.script
25 | await script.run_script(unk_args)
26 |
27 |
28 | def entry():
29 | asyncio.run(main(), loop_factory=evloop.new_event_loop)
30 |
31 |
32 | if __name__ == "__main__":
33 | entry()
34 |
--------------------------------------------------------------------------------
/templates/secretbox_detail.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
14 |
15 |
16 |
17 | | Rarity | 24 |Weight | 25 |Percentage | 26 |
|---|---|---|
| {{ i[0] }} | 32 |{{ i[1] }} | 33 |{{ "%.2f" % (i[2] * 100) }}% | 34 |
{{ bg.description_en.replace('\\n','\n') }} |
| Parameter | 29 |Value | 30 |
|---|---|
| {{ i[0] }} | 34 |{{ i[1] | safe }} | 35 |
18 | 
28 |
19 | {{ error }}
26 |
30 | Please populate the JSON response data of particular endpoint.
67 |/user/userInfo
68 | 69 |/api (large one, the first one)
71 | 72 |/api (small one, the second one)
74 | 75 |Converted data goes here
83 | 84 |Signature
85 | 86 | 87 | 88 | 89 | -------------------------------------------------------------------------------- /templates/serialcode.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 15 | 70 | 71 | 72 | 73 |