- Python 95.6%
- JavaScript 4.4%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| access_control | ||
| calculation | ||
| carbon | ||
| smslogin | ||
| LICENSE | ||
| README.md | ||
Addons Module Docs (English)
This repository contains 4 Odoo Addons: carbon, calculation, smslogin, and access_control. They implement a carbon-accounting prototype (entities + formulas + results + reports), configurable calculation logic, SMS-based verification/login (with Alibaba Cloud Captcha), and frontend access control.
Note: This document is generated from the actual code and manifests (
__manifest__.py) in this repo.
1. Runtime & Common Conventions
- Framework: Odoo (standard addon structure with
models/,views/,security/, manifests, etc.) - REST framework:
smsloginandcarbonexpose APIs viaodoo.addons.base_rest.controllers.main.RestController, so you need thebase_reststack (and its component dependencies).smslogin/controllers/controllers.py:_root_path = '/api/sms/v2/'carbon/controllers/controllers.py:_root_path = '/api/carbon/v2/'
- Role model: multiple modules use
security.roleandres.users.security_role_ids. Also,access_control/views/security_role_extend.xmlinheritssecurity_user_roles.security_role_view_form, so you typically need asecurity_user_roles-like addon providing the role model + view.
2. carbon: Carbon Accounting (Prototype + Entities + Formulas + Results + Reports)
2.1 Purpose
carbon provides a runnable carbon-accounting prototype:
- Project + scheme modeling
- Inventory libraries and emission-factor entities
- Two computation modes:
rough: screening-level / scheme comparisonfine: detailed accounting per stage/category
- Persisted results (per stage, and per category)
- Reports (QWeb + PDF download with charts)
Manifest: carbon/__manifest__.py
2.2 REST API & Report Download
Controller: carbon/controllers/controllers.py
- Root path:
/api/carbon/v2/ - Collection:
carbon.project.services - Report download:
GET /download_report?id=<id>&mode=<rough|fine|rough_compare|fine_compare>- Internally calls Odoo report rendering (
report_routes) and returns a PDF
Service: carbon/services/model_services.py
Endpoints (selected; full list is in the file):
- User:
GET|PUT /users/infoGET /users/rolesGET|POST|PUT|DELETE /users/childs
- Projects:
GET|POST|PUT|DELETE /users/projectsPUT|DELETE /users/projects/<project_id>/schemesGET|POST /users/projects/<id>/resultGET /users/projects/<id>project details (inventory + stages + schemes + submitted data)GET /users/projects/ranking(top 5)GET /users/projects/overview(grouped by city)
- Inventories:
GET|POST|PUT|DELETE /users/inventoriesGET|POST|PUT|DELETE /users/inventories/details
- Base data:
GET /units,GET /stages,GET /stages/<id>/links,GET /stages/<id>/inventoriesGET /layers,GET /compositions,GET /layers/<id>/compositions(inventory-aware options)GET /citys,GET /geojson
2.3 Core Entities (Partial)
Projects & schemes:
carbon.project(carbon/models/carbon_project.py)mode,stage_ids,fine_stage_ids,inventory_id,scheme_idsactive_scheme_idprefers completedfine, otherwise completed+selectedrough
carbon.project.scheme(carbon/models/carbon_project_scheme.py)dataas JSON textcalc_rough()andcalc_fine(...)
carbon.project.result(carbon/models/carbon_project_result.py)- metrics:
res_all,res_area,res_year,res_area_year category_resultas JSON
- metrics:
Stages & process steps:
carbon.stage(carbon/models/carbon_stage.py) withsequenceandcodecarbon.link(carbon/models/carbon_link.py) withsequenceandstage_id
Structural layers:
structural.layer(carbon/models/structural_layer.py)structural.layer.composition(carbon/models/structural_layer_composition.py) includescode,type, andcolumnsconfiguration
Inventory library:
life.cycle.inventory(carbon/models/life_cycle_inventory.py)life.cycle.inventory.type(carbon/models/life_cycle_inventory_type.py) binds tocarbon.linkand allowed unitsmaterial.life.cycle.inventory(carbon/models/material_life_cycle_inventory.py)carbon.life.cycle.inventory(carbon/models/carbon_life_cycle_inventory.py)
Geo/admin regions:
res.country.state.city.district(carbon/models/res_country_state_city_district.py)district_importfetches geojson fromhttps://geo.datav.aliyun.com/areas_v2/bound/<code>.json
2.4 Computation Logic (As Implemented)
rough(scheme comparison / screening-level)
- Entry:
carbon.project.scheme.calc_rough() - Formulas:
- functions imported from
carbon/tests/fun.py(e.g.,calc_LQ_A1,calc_JC_A2,calc_D2, ...)
- functions imported from
- Inputs:
scheme.dataJSON (LayerData,wyData, ...)- emission factors selected from
material.life.cycle.inventoryetc. byinventory_idandcomposition_id
- Output:
- writes
carbon.project.resultper stage - writes
category_resultJSON (aggregated categories)
- writes
fine(detailed accounting)
- Entry:
carbon.project.scheme.calc_fine(stage_id, scheme_id, scheme_data, project) - Core:
- base term:
factor_number * number - if category is
A2anddistanceis present: multiply bydistance - if
link_idis provided: derives categories likeA1/A2/.../D2fromstage.code + link.sequence - special handling for stage code
C: computes and adds"Traffic delay"
- base term:
- Output:
- persists stage metrics and
category_resultintocarbon.project.result
- persists stage metrics and
2.5 Reports & Charts
- QWeb report templates:
carbon/reports/*.xml - Report builders:
carbon/models/project_report.py- generates pie/bar charts with
matplotlib/numpy - uses Chinese font
carbon/static/fonts/simhei.ttf - writes images to
carbon/static/src/images/(names include scheme id + timestamp) /download_reportwraps the Odoo report engine and returns a PDF
- generates pie/bar charts with
3. calculation: Configurable Calculation Logic (Dynamic Execution)
3.1 Purpose
calculation stores executable code snippets in Odoo and provides an execution entrypoint. It can be used to externalize carbon formulas per category/stage so formulas can be updated without a deployment.
Manifest: calculation/__manifest__.py
3.2 Model & Execution
Model: calculation.model (calculation/models/calculation_model.py)
- Fields:
name: lookup key for the calculation recordparams: parameter placeholder/name (string)code: code snippet (string)
- Execution:
start_run(self, name, **params)looks up bynameand runs:exec(m.code.replace(m.params, params.get(m.params)))
UI: calculation/views/calculation_model.xml
- A
RUNbutton triggersstart_run
4. smslogin: SMS Verification + Login (Alibaba Cloud Captcha)
4.1 Purpose
smslogin provides frontend-facing auth APIs:
- Send SMS verification codes (after Alibaba Cloud Captcha 2.0 validation)
- Register (creates
res.users, binds default roles, binds default data) - Login via password or SMS verification code, with optional session concurrency limits
- Change password
Manifest: smslogin/__manifest__.py
4.2 REST API Entry
Controller: smslogin/controllers/controllers.py
- Root path:
/api/sms/v2/ - Collection:
sms.services
Service: smslogin/services/model_services.py
Endpoints (as implemented):
POST /api/sms/v2/sendsms(auth='public')POST /api/sms/v2/register(auth='public')POST /api/sms/v2/prelogin(auth='public')POST /api/sms/v2/login(auth='public')POST /api/sms/v2/password(auth='user')
Datamodels: smslogin/datamodels/datamodels.py
4.3 Key Models
verify.code(smslogin/models/verify_code.py)- 5-minute expiry via
com_is_expired check_verify_code(verifycode, phone)marks the code used when valid
- 5-minute expiry via
login.record(smslogin/models/login_record.py) storessid, method, IP, timestampcaptcha.record(smslogin/models/captcha_record.py) exists but is marked deprecated; the current API flow does not persist Captcha tokens here
4.4 Required Configuration (ir.config_parameter)
As read by smslogin/services/model_services.py:
ACCESS_KEY_ID/ACCESS_KEY_SECRET: used to sign Alibaba Cloud Captcha requestssms.config: SMS gateway config (JSON string)- the code does
replace('%', code).replace('$', phone)thenjson.loads - expected keys:
active_platform, and platform config{url, params}
- the code does
max.session: max concurrent sessions per user (default 1)- login code scans
http.root.session_store.pathforwerkzeug_*.sessand deletes extra session files
- login code scans
5. access_control: Frontend Page/Button Access Control
5.1 Purpose
access_control manages frontend permissions for:
- Pages/routes (by route
path) - Buttons inside a route (by button
domId, with a configurablestate) - Navigation entries (menu visibility/availability)
Manifest: access_control/__manifest__.py
5.2 Data Model (Key Odoo Models)
Route and button definitions:
access.route(access_control/models/access_route.py)name,path,pid/children(tree routing)buttons: one2many toaccess.route.button
access.route.button(access_control/models/access_route_button.py)domId: frontend DOM identifiername: display labelroute_id: parent route
access.navigation(access_control/models/access_navigation.py)name,route_id(andpathvia related field)sequencewith uniqueness check on change
Role → permission mapping:
role.access.route(access_control/models/role_access_route.py)role_id→security.roleroute_id→access.routebuttons: one2many torole.access.route.button
role.access.route.button(access_control/models/role_access_route_button.py)role_route_id→role.access.routebutton_id→access.route.buttonstate: button state exposed to the frontend
role.access.navigation(access_control/models/role_access_navigation.py)role_id→security.rolenavigation_id→access.navigationavailable: if false, the web API returnsdisabled: true
Role extension:
SecurityRoleExtend(access_control/models/extend.py) extendssecurity.roleget_role_access()/get_role_access_by_web(): routes + buttonsget_role_navigation_access()/get_role_navigation_access_by_web(): navigation entriesconfigure_routing_permissions()/configure_navigation_permissions(): returnsir.actions.clientfor the config panels
5.3 Backend UI & Config Panels
Assets and menus: access_control/views/menu.xml
- Injects JS into
web.assets_backend:access_control/static/src/js/operate_access.jsaccess_control/static/src/js/operate_navigation_access.js
- Defines
ir.actions.client:tag = operate_access: route/button configuration paneltag = operate_navigation_access: navigation configuration panel
- Adds menu entries under Access Control
QWeb templates: access_control/static/src/xml/template.xml
operate_access_template: per-role route list, button state config, add/delete routesoperate_navigation_access_template: per-role navigation config, add/delete navigation
Role form buttons: access_control/views/security_role_extend.xml
- Adds two buttons on
security.role:Configure Route PermissionsConfigure Navigation Permissions
5.4 HTTP API (Frontend Consumption & Sync)
Controller: access_control/controllers/main.py
- Fetch navigation permissions for the current user:
GET /api/get_user_navigations(auth='user')- Returns a dict keyed by role id with
navigations[{path,name,disabled?}]
- Fetch route + button permissions for the current user:
GET /api/get_user_routes(auth='user')- Returns a dict keyed by role id with
routes[{id,pid,path,buttons[{domId,name,state}]}]
- Sync frontend routes into Odoo:
POST /api/routes(type='json',auth='user')- Key behavior:
- Deletes and rebuilds
access.routeandrole.access.route(viasearch([]).unlink()) - Recursively creates route tree, and creates buttons from
route.meta.buttons
- Deletes and rebuilds
- Expected route fields (based on code):
path,namemeta.buttons: array of dicts written intoaccess.route.button(commonlydomId,name, etc.)
5.5 Recommended Workflow
- Frontend publishes the route list (including button metadata), then calls
POST /api/routes - Configure
access.navigationitems in Odoo (bind a navigation entry to a route, setsequence) - For each
security.role, grant:- allowed routes + button states (via “Control Panel” or role form buttons)
- allowed navigation items (
availablecontrolsdisabled)
- Frontend calls:
GET /api/get_user_routesto enforce page/button accessGET /api/get_user_navigationsto render/disable menus
6. Inter-module Relationships (Current Code)
smsloginregistration assignssecurity_role_idsby referencingcarbonrole xmlids.access_controlexports permission data keyed bysecurity.role;carbondefines several roles incarbon/views/security_role_data.xml.calculationis not directly referenced bycarbonyet, but it is suitable for externalizing/updating carbon formulas dynamically.
7. Quick Code Entry Index
carbon:carbon/controllers/controllers.py,carbon/services/model_services.py,carbon/models/carbon_project_scheme.py,carbon/tests/fun.py,carbon/models/project_report.py,carbon/reports/*.xmlcalculation:calculation/models/calculation_model.pysmslogin:smslogin/controllers/controllers.py,smslogin/services/model_services.py,smslogin/models/*.py,smslogin/datamodels/datamodels.pyaccess_control:access_control/controllers/main.py,access_control/models/extend.py,access_control/static/src/js/*,access_control/static/src/xml/template.xml
8. License
This project is licensed under LGPL-3.0-or-later. See LICENSE.
9.Access
The software is accessible via the following website:
🔗 https://carbon.roadpioneer.cn/
The platform allows users to perform pavement carbon emission calculations without requiring access to the underlying source code.