5jDVdZddlZddlZddlZddlZddlmZmZddlmZ ddl Z ddl Z ejdZ eejj Zeej$j'dedz Zeej$j'ded z Zee d dxsed z Zd Zd ZdZdZdZd)dZd)dZd)dZd)dZ d)dZ!dZ"d)dZ#ddddddddZ$dZ%ddddZ&d)dd d!Z'd"Z(d#Z)d*d$Z*d%Z+d&Z,d'Z-d(Z.y#e $rdZ YwxYw#e $rdZ YwxYw)+u scada_report_approvals.py — SCADA report approver→send workflow (DVI-1102, SCADA View Reporting F4). Part of SCADA View Reporting (DVI-1095). A small, Flask-independent engine module (mirrors ``scada_report.py`` / ``scada_store.py``) shared by BOTH the web app (``app.py`` — approver UI + approve/reject routes) and the standalone report scheduler (``scada_report_scheduler.py`` — enqueues external sends for approval). Why this exists --------------- Scheduled and manual SCADA reports are emailed to three recipient groups (DVI-487): per-schedule *notify*, global *enforced*, and global *external*. F4 adds a single-approver gate — modeled on the WO Approvals pattern — so **no report is ever auto-sent to EXTERNAL recipients without an explicit approval**. Scope decision (documented, not silent — the issue names "External recipients"): * The gate applies ONLY to the *external* recipient list. Internal delivery (per-schedule notify + enforced recipients) still happens at generation time, unchanged — those audiences are trusted staff, and gating them would silently stop every scheduled report the moment the feature deploys. * When a report has external recipients, instead of sending to them the caller enqueues an ``awaiting_approval`` request here and notifies the configured approver(s). An approver approves (→ the persisted XLSX is emailed to the external list + the send is logged) or rejects (→ recorded, never sent). * "Single-approver" = a single approval suffices; any configured approver (or a Togen/SCADA admin, enforced in app.py) may action a request. No-approver safety ------------------ If a report has external recipients but NO approver is configured, the request is still enqueued as ``awaiting_approval`` (the invariant "never auto-sent externally" holds) and ``enqueue_external_send`` returns ``notified=False`` so the caller can surface a LOUD warning to the enforced/internal recipients rather than silently dropping external delivery (the DVI-1114 class of failure). State ----- ``scada_report_approvals.json`` — a JSON list of request records, newest last. The persisted XLSX itself lives in the shared ``reports/`` dir (written by the scheduler / on-demand generation); a request references it by bare filename. Record shape:: { "id": "", "created_at": ISO-8601, "source": "schedule" | "manual", "schedule_id": str | null, "report_name": str, # human schedule/report name "report_type": str, # registry id (DVI-1101), e.g. "kiln_temp" "date_from": "YYYY-MM-DD" | null, "date_to": "YYYY-MM-DD" | null, "row_count": int, "report_file": ".xlsx", # bare filename in the reports dir "attach_name": str, # email attachment filename "subject": str, "recipients": ["a@b.com", ...], # external list to send on approve "requested_by": str, # "scheduler" or a user email "status": "awaiting_approval" | "approved" | "rejected", "actioned_by": str | null, "actioned_at": ISO-8601 | null, "reject_reason": str | null, "send_status": null | "sent" | "send_failed" } N)datetimetimezone)Pathscada_report_approvalsSCADA_REPORT_APPROVALSzscada_report_approvals.jsonSCADA_REPORTS_DIRreportsSCADA_CONFIG_PATHzscada_config.jsonzAapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetawaiting_approvalapprovedrejectedcdtjtjj SN)rnowrutc isoformat-/var/www/html/togen/scada_report_approvals.py_now_isorqs << % / / 11rcF|r t|nt}|jsgS tj|j }t|tr!|Dcgc]}t|ts|c}SgS#tj tf$rgcYSwxYwcc}w)z8Load the approval request list ([] when absent/invalid).) rAPPROVALS_FILEis_filejsonloads read_textJSONDecodeErrorOSError isinstancelistdict)pathdatars rload_approvalsr%us4:>D <<> zz$..*+8B$7Mt 3!z!T2A 3USUU  ' *  3s#A=B4B=BBc|r t|nt} |jtj|dy#t $rt jd|YywxYw)N)indentTzFailed to persist %sF)rr write_textrdumpsr_LOG exception)recordsr"s r_save_approvalsr.sO4:>D  7156  -t4s&<AAcTt|D]}|jd|k(s|cSy)z'Return a single request by id, or None.idN)r%get) request_idr"r$s r get_requestr3s0 D ! 55;* $H rctt|Dcgc]}|jdtk(r|c}Scc}w)z/Requests still awaiting approval, newest first.status)reversedr%r1STATUS_AWAITING)r"r$s rpendingr8s;t 45 3!uuX/1  33 3s!;c2|r t|nt}|jsgS tj|j }t|tr|jdnd}t|S#tj tf$rgcYSwxYw)uReturn the configured approver emails (lowercased, de-duped). Reads ``report_approvers`` from scada_config.json — the same file the Flask UI and the scheduler share — so both processes see one source of truth without app.py having to hand the list to the scheduler. report_approversN) r_SCADA_CONFIG_PATHrrrrrrrr!r1normalize_approvers) config_pathr"cfgraws rr:r:s!,4 1CD <<> jj)**4C)>#''$ %DC s ##  ' * s#A88BBc t|tsgStg}}|D]`}t|ts|j j }|s5d|vs:||vs?|j ||j|b|S)zNormalize an approver list: lowercased, trimmed, de-duped, order-stable. Also used by app.py to validate the list on save. @)rr setstrstriploweraddappend)r?seenoutenorms rr<r<sz c4  r#D !S! wwy  C4KD$4 HHTN JJt   Jrcvt|tsy|jjt |vS)z5True if ``email`` is in the configured approver list.F)rrCrDrEr:)emailr=s r is_approverrNs/ eS ! ;;=   $4[$A AArschedule schedulerT)source schedule_id requested_byr"r=notifycidtjjdtd| d| d|d|d|d|d t |xsd d |d |d |dt |xsgd| dt ddddddd}t| }|j|t|| t| }d}|r|r t||}|||dS)uRecord an ``awaiting_approval`` request for an EXTERNAL report send and (optionally) notify the configured approver(s). ``report_file`` is the bare filename of the already-persisted XLSX in the reports dir. ``recipients`` is the external recipient list to email on approval. Returns ``{"request": record, "approvers": [...], "notified": bool}``. ``notified`` is False when no approver is configured (caller should surface a loud warning — external delivery is held, not sent). r0 created_atrQrR report_name report_type date_fromdate_to row_countr report_file attach_namesubject recipientsrSr5 actioned_byN actioned_at) reject_reason send_statusF)request approversnotified) uuiduuid4hexrintr r7r%rGr.r:_notify_approvers)rWrXrYrZr[r\r]r^r_rQrRrSr"r=rTrecordr-rerfs renqueue_external_sendrmsN djjlhj & {  {  {  Y 7 Sa( { { 7 d:+,   / t!" t#$'F*T"G NN6GT" -IH )$VY7I8 LLrc d|D]+}|jd|k(s|j||cSy)Nr0)r1update)r-r2fieldsr$s r_setrqs7  55;* $ HHV H r)r" reports_dirc$t|}tfd|Dd}|ddddS|jdtk7rd|d|jdddS|r t |nt }|jd xsd }|r|t |j k7rd|d dS||z j} |j|j|jsd|d dS|jd xsg} | s9t|t|tdt||dt|ddS|j!} t#|} d} t$Bt%j&| |jdd| |jdxs|| t(} t|t|t| rdndt||t+|| | | sdt|ddSdt|ddS#t$r d|d dcYSwxYw)alApprove a request and email the persisted XLSX to its external recipients. Returns ``{"ok": bool, "record": record|None, "error": str|None}``. The record's ``status`` becomes ``approved`` regardless of send outcome (the approval decision stands); ``send_status`` records whether the email went out so a failed send can be retried from the UI. c3LK|]}|jdk(s|ywr0Nr1.0r$r2s r zapprove.. Ct )B1C$$NFApproval request not found.okrlerrorr5Request already .r\zInvalid report file.z*Report file no longer exists; cannot send.r_ no_recipients)r5r`rarcTr^ SCADA Reportr])filenamecontent content_typesent send_failedzCApproved, but the email send failed. Retry from the approvals list.)r%nextr1r7r REPORTS_DIRnameresolve relative_to ValueErrorrrqSTATUS_APPROVEDrr.r3 read_bytes_approved_email_html notificationssend_email_with_attachmentXLSX_CONTENT_TYPE_log_external_send) r2r`r"rrr-rlr r report_pathr_r#htmlrs ` rapprovers3T"G CgCT JF ~t6STT zz(.v+FJJx,@+ACE E$/d;KG ::m $ *D 44:??*v8NOOT>**,KP 12    vEG GL)/RJ  Wj$(*( * &k*d&CdSS  ! ! #D  'D D 77  9n=tZZ .6$'8: *_+ZtVPGT"vz40 {:t'D+, ,+j$"?$ OO? Pv8NOOPs7G==HH)r"c Tt|}tfd|Dd}|ddddS|jdtk7rd|d|jdddSt |t |t |xsd jxsd t||d t|ddS) zBReject a request. The report is never sent to external recipients.c3LK|]}|jdk(s|ywrurvrws rryzreject..Drzr{NFr|r}r5rrr)r5r`rarbT) r%rr1r7rqSTATUS_REJECTEDrrDr.r3)r2r`reasonr"r-rls` rrejectrAsT"G CgCT JF ~t6STT zz(.v+FJJx,@+ACE E*_+Z "/C/C/E/MOGT"+j$"?$ OOrcxt|jddjddjddS)N&z&z>)rCreplace)values r_escrTs1 J WS' "773#7V8LNrc d}|jds|jdr-|jdxsdd|jdxsd}d|jddfd|fd t|jd d fd d j|jdxsgfg}djd|DS)NrrYrZu…u – ReportrWz Date rangeRowsr[rzExternal recipientsz, r_c3pK|].\}}|r'djt|t|0yw)z{lbl}{val})lblvalN)formatr)rxrrs rryz_detail_rows..cs@R:BcS 49$s)4 5Rs46)r1rCjoin)rlrngrowss r _detail_rowsrYs C zz+&**Y"7K(1E2% 98M8VQV7WX 6::mR01 s VZZ Q/01  &**\*B*Hb IJ  D 77RFJ R RRrct2ttdr"tjt||||Sdt|d||dS)Nrender_email_shelltitle body_htmlsubtitle footer_htmlz

z

z)rhasattrrrrs r_shellrjsR W]A SCADA report is awaiting your approval before it can be emailed to external recipients.

uS

Review it in Togen → SCADA View → Report Notifications → Pending Approvals.

z

You are receiving this because you are a configured SCADA report approver.

u!Approval needed: SCADA report “rWru”zSCADA Report ApprovalzFailed to notify approvers) rrrrr1rboolsend_html_email Exceptionr+r,)rlrelinkbodyfooterr^rs rrkrkws -D &)5V(<  =@J< 7@7  7  % 2&**]22N1OsSG '4!8& ADM11)WdKLL  34sA::BBcddt|zdz}d}t|jdd|d|S)Nz

The attached SCADA report has been approved and is provided for your records.

z
z

You are receiving this because you are an external recipient of this SCADA report.

r^r)rrr1)rlrrs rrrsU &)5V(< =@J J  . &**Y7 & **rcty |D]/}tjd|jd|rdnd|1y#t$rtj dYywxYw)zABest-effort notification-log entry for the external send (audit).Nz scada_report:r0rrz(Failed to log external SCADA report send)r _record_sentr1rr+r,)rlr_rr$s rrrskC 6A  & & 4 012M1 6 6 C ABCs4>AAr)r)/__doc__rloggingrrgrrpathlibrr ImportError scada_report getLoggerr+__file__rparent _BASE_DIRrr1rrgetattrr;rr7rrrr%r.r3r8r:r<rNrmrqrrrrrrrkrrrrrrsBH  'w12 N " " $ + + JJNN+<<>?2::>>"5y97LMN  L-t4)'' H&2 V3$$$B.8T'2&*4 ,Mf.2t7Pt P P&N R"W9 8 * Cg M Ls"DDDDD('D(