main.py 570 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789
  1. import asyncio
  2. import json
  3. import logging
  4. import math
  5. import os
  6. import posixpath
  7. import re
  8. import secrets
  9. import time
  10. from contextlib import asynccontextmanager
  11. from datetime import datetime, timedelta, timezone
  12. from logging.handlers import RotatingFileHandler
  13. from pathlib import Path, PurePosixPath
  14. from urllib.parse import urlparse
  15. from fastapi import FastAPI
  16. from fastapi.responses import FileResponse
  17. from fastapi.staticfiles import StaticFiles
  18. from sqlalchemy import delete, inspect as sa_inspect, or_, select, text, update
  19. from sqlalchemy.exc import IntegrityError
  20. from sqlalchemy.orm.exc import StaleDataError
  21. from backend.app.api.routes import (
  22. ams_history,
  23. announcements,
  24. api_keys,
  25. archive_purge,
  26. archives,
  27. auth,
  28. bug_report,
  29. camera,
  30. camwall,
  31. cloud,
  32. connected_apps,
  33. discovery,
  34. external_links,
  35. filaments,
  36. finance,
  37. firmware,
  38. github_backup,
  39. groups,
  40. ha_sensors,
  41. inventory,
  42. kprofiles,
  43. labels,
  44. library,
  45. library_tags,
  46. library_trash,
  47. library_variants,
  48. local_backup,
  49. local_presets,
  50. location_ha_sensors,
  51. maintenance,
  52. makerworld,
  53. manyfold,
  54. metrics,
  55. mfa,
  56. notification_templates,
  57. notifications,
  58. obico,
  59. orca_cloud,
  60. overlay_branding,
  61. pending_uploads,
  62. pipeline_runs,
  63. print_log,
  64. print_queue,
  65. printer_locations,
  66. printer_sensor_history,
  67. printers,
  68. projects,
  69. scheduled_dryings,
  70. settings as settings_routes,
  71. slice_jobs,
  72. slicer_pipelines,
  73. slicer_presets,
  74. smart_plugs,
  75. sponsor_prompt,
  76. spoolbuddy,
  77. spoolman,
  78. spoolman_inventory,
  79. support,
  80. system,
  81. updates,
  82. user_notifications,
  83. users,
  84. virtual_printers,
  85. webhook,
  86. websocket,
  87. )
  88. from backend.app.api.routes.maintenance import (
  89. _get_printer_maintenance_internal,
  90. ensure_default_types,
  91. maintenance_alert_values,
  92. )
  93. from backend.app.api.routes.support import init_debug_logging
  94. from backend.app.core.config import APP_VERSION, settings as app_settings
  95. from backend.app.core.database import async_session, engine, init_db
  96. from backend.app.core.static_assets import AssetStaticFiles
  97. from backend.app.core.tasks import spawn_background_task
  98. from backend.app.core.websocket import ws_manager
  99. from backend.app.services import kprofile_drift, print_dispatch_context, slot_unlink_grace
  100. from backend.app.services.archive import ArchiveService, peek_plate_index_in_3mf, swap_plate_suffix
  101. from backend.app.services.archive_cost_estimate import (
  102. schedule_archive_cost_estimate as _schedule_archive_cost_estimate,
  103. )
  104. from backend.app.services.archive_purge import archive_purge_service
  105. from backend.app.services.bambu_ftp import (
  106. RECOVERY_DOWNLOAD_MAX_TIMEOUT,
  107. FileNotOnPrinterError,
  108. cache_3mf_download,
  109. clear_3mf_cache,
  110. download_file_async,
  111. download_file_try_paths_async,
  112. ftps_handshake_blocked,
  113. get_cached_3mf,
  114. get_ftp_retry_settings,
  115. normalize_3mf_name,
  116. with_ftp_retry,
  117. )
  118. from backend.app.services.bambu_mqtt import PrinterState
  119. from backend.app.services.camera_light import camera_light
  120. from backend.app.services.energy_plug import energy_plug_candidates, select_energy_reading
  121. from backend.app.services.github_backup import github_backup_service
  122. from backend.app.services.ha_sensor_manager import ha_sensor_manager
  123. from backend.app.services.library_trash import library_trash_service
  124. from backend.app.services.local_backup import local_backup_service
  125. from backend.app.services.location_ha_sensor_manager import location_ha_sensor_manager
  126. from backend.app.services.mqtt_relay import mqtt_relay
  127. from backend.app.services.mqtt_smart_plug import mqtt_smart_plug_service
  128. from backend.app.services.notification_service import notification_service
  129. from backend.app.services.notify_live_activities import notify_live_activities
  130. from backend.app.services.notify_widgets import notify_widgets
  131. from backend.app.services.obico_detection import obico_detection_service
  132. from backend.app.services.plug_energy import get_plug_energy as _get_plug_energy
  133. from backend.app.services.print_cost_estimate import plate_scoped_run_estimate as _plate_scoped_run_estimate
  134. from backend.app.services.print_scheduler import scheduler as print_scheduler
  135. from backend.app.services.print_storage import (
  136. REASON_FTP_TRANSFER_FAILED,
  137. REASON_FTPS_COOLOFF,
  138. external_storage_present,
  139. ftp_probe_paths,
  140. print_file_reachable_over_ftp,
  141. )
  142. from backend.app.services.printer_manager import (
  143. init_printer_connections,
  144. parse_plate_id,
  145. printer_manager,
  146. printer_state_to_dict,
  147. resolve_plate_id,
  148. )
  149. from backend.app.services.slot_kprofile import find_slot_kprofile_for_extruder
  150. from backend.app.services.slot_nozzle import (
  151. nozzle_diameter_for_extruder,
  152. nozzle_flow_for_extruder,
  153. )
  154. from backend.app.services.smart_plug_manager import smart_plug_manager
  155. from backend.app.services.spool_assignment_notifications import (
  156. notify_missing_spool_assignments_on_print_start,
  157. )
  158. from backend.app.services.spool_filament_preset import printer_safe_filament_id
  159. from backend.app.services.spoolman import close_spoolman_client, get_spoolman_client, init_spoolman_client
  160. from backend.app.services.spoolman_tracking import (
  161. cleanup_tracking as _cleanup_spoolman_tracking,
  162. release_archived_slot_rows as _release_archived_spoolman_slots,
  163. report_usage as _report_spoolman_usage,
  164. store_print_data as _store_spoolman_print_data,
  165. )
  166. from backend.app.services.telegram_reactions import telegram_reaction_poller
  167. from backend.app.utils.ams_drying import is_drying_active, temperature_alarm_suppressed
  168. from backend.app.utils.ams_humidity import ams_humidity_percent
  169. from backend.app.utils.filament_types import printer_filament_type
  170. from backend.app.utils.fts_routing import extruder_for_inlet
  171. from backend.app.utils.local_time import to_naive_utc, utcnow_naive
  172. from backend.app.utils.print_jobs import is_internal_printer_job
  173. # =============================================================================
  174. # Dependency Check - runs before other imports to give helpful error messages
  175. # =============================================================================
  176. def _start_error_server(missing_packages: list):
  177. """Start a minimal HTTP server to display dependency errors in browser."""
  178. import os
  179. import signal
  180. from http.server import BaseHTTPRequestHandler, HTTPServer
  181. packages_html = "".join(f"<li><code>{p}</code></li>" for p in missing_packages)
  182. html = f"""<!DOCTYPE html>
  183. <html>
  184. <head>
  185. <title>Bambuddy - Setup Required</title>
  186. <style>
  187. body {{
  188. font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
  189. background: #0f172a; color: #e2e8f0;
  190. display: flex; justify-content: center; align-items: center;
  191. min-height: 100vh; margin: 0; padding: 20px; box-sizing: border-box;
  192. }}
  193. .container {{
  194. background: #1e293b; border-radius: 12px; padding: 40px;
  195. max-width: 600px; text-align: center; box-shadow: 0 4px 20px rgba(0,0,0,0.3);
  196. }}
  197. h1 {{ color: #f87171; margin-bottom: 10px; }}
  198. h2 {{ color: #94a3b8; font-weight: normal; margin-top: 0; }}
  199. .packages {{
  200. background: #0f172a; border-radius: 8px; padding: 20px;
  201. margin: 20px 0; text-align: left;
  202. }}
  203. .packages ul {{ margin: 0; padding-left: 20px; }}
  204. .packages li {{ color: #fbbf24; margin: 8px 0; }}
  205. .command {{
  206. background: #0f172a; border-radius: 8px; padding: 15px 20px;
  207. margin: 15px 0; font-family: monospace; color: #4ade80;
  208. text-align: left; overflow-x: auto;
  209. }}
  210. .note {{ color: #94a3b8; font-size: 14px; margin-top: 20px; }}
  211. </style>
  212. </head>
  213. <body>
  214. <div class="container">
  215. <h1>Setup Required</h1>
  216. <h2>Missing Python packages</h2>
  217. <div class="packages"><ul>{packages_html}</ul></div>
  218. <p>To fix, run this command on your server:</p>
  219. <div class="command">pip install -r requirements.lock</div>
  220. <p>Or if using a virtual environment:</p>
  221. <div class="command">./venv/bin/pip install -r requirements.lock</div>
  222. <p class="note">After installing, restart Bambuddy:<br>
  223. <code>sudo systemctl restart bambuddy</code></p>
  224. </div>
  225. </body>
  226. </html>"""
  227. class ErrorHandler(BaseHTTPRequestHandler):
  228. def do_GET(self):
  229. self.send_response(503)
  230. self.send_header("Content-type", "text/html")
  231. self.end_headers()
  232. self.wfile.write(html.encode())
  233. def log_message(self, format, *args):
  234. print(f"[Error Server] {args[0]}")
  235. port = int(os.environ.get("PORT", 8000))
  236. print(f"\nStarting error server on http://0.0.0.0:{port}")
  237. print("Visit this URL in your browser to see the error details.\n")
  238. server = HTTPServer(("0.0.0.0", port), ErrorHandler) # nosec B104
  239. def shutdown(signum, frame):
  240. print("\nShutting down error server...")
  241. raise SystemExit(0)
  242. signal.signal(signal.SIGTERM, shutdown)
  243. signal.signal(signal.SIGINT, shutdown)
  244. server.serve_forever()
  245. def check_dependencies():
  246. """Check that all required packages are installed."""
  247. missing = []
  248. # Map of import name -> package name (for pip install)
  249. required = {
  250. "jwt": "PyJWT",
  251. "fastapi": "fastapi",
  252. "uvicorn": "uvicorn",
  253. "sqlalchemy": "sqlalchemy",
  254. "aiosqlite": "aiosqlite",
  255. "pydantic": "pydantic",
  256. "paho.mqtt": "paho-mqtt",
  257. }
  258. for module, package in required.items():
  259. try:
  260. __import__(module)
  261. except ImportError:
  262. missing.append(package)
  263. if missing:
  264. print("\n" + "=" * 60)
  265. print("ERROR: Missing required Python packages!")
  266. print("=" * 60)
  267. print(f"\nMissing packages: {', '.join(missing)}")
  268. print("\nTo fix, run:")
  269. print(" pip install -r requirements.lock")
  270. print("\nOr if using a virtual environment:")
  271. print(" ./venv/bin/pip install -r requirements.lock")
  272. print("=" * 60 + "\n")
  273. _start_error_server(missing)
  274. check_dependencies()
  275. # =============================================================================
  276. # Import settings first for logging configuration
  277. # Configure logging based on settings
  278. # DEBUG=true -> DEBUG level, else use LOG_LEVEL setting
  279. log_level_str = "DEBUG" if app_settings.debug else app_settings.log_level.upper()
  280. log_level = getattr(logging, log_level_str, logging.INFO)
  281. # Trace ID column ([-] when no request scope is active — startup, MQTT
  282. # callbacks, scheduled tasks not chained from a request — so the column
  283. # stays visually aligned and missing values are obvious in grep). See
  284. # backend/app/core/trace.py for the ContextVar that feeds this slot.
  285. log_format = "%(asctime)s %(levelname)s [%(name)s] [%(trace_id)s] %(message)s"
  286. # Create root logger
  287. root_logger = logging.getLogger()
  288. root_logger.setLevel(log_level)
  289. # Trace-ID injection: this filter populates record.trace_id from the
  290. # per-request ContextVar so the format string above can reference it.
  291. # Attached to each HANDLER (not the root logger) because Python's
  292. # logging semantics only invoke a logger's filters on records that
  293. # *originated* at that logger — records propagated up from child
  294. # loggers (every named logger in the app) never trigger root's filter.
  295. # Putting it on the handlers means every record any handler emits gets
  296. # trace_id injected just before the formatter runs, regardless of which
  297. # logger created the record. Without this, the formatter raises
  298. # KeyError on every child-logger record and the record is silently
  299. # dropped — which is exactly the "logs/bambuddy.log only shows logs
  300. # partially" bug we hit. See backend/app/core/trace.py for the
  301. # ContextVar the filter reads.
  302. from backend.app.core.logging_filters import RefusedHeaderRedactFilter
  303. from backend.app.core.response_redaction import RefusedHeaderResponseMask
  304. from backend.app.core.trace import TraceIDFilter
  305. _trace_id_filter = TraceIDFilter()
  306. # Console handler - always enabled
  307. console_handler = logging.StreamHandler()
  308. console_handler.setLevel(log_level)
  309. console_handler.setFormatter(logging.Formatter(log_format))
  310. console_handler.addFilter(_trace_id_filter)
  311. # A refused header's value (often a token) masked before the line is written.
  312. _refused_header_filter = RefusedHeaderRedactFilter()
  313. console_handler.addFilter(_refused_header_filter)
  314. root_logger.addHandler(console_handler)
  315. def _attach_file_handler_to_uvicorn(handler: logging.Handler) -> None:
  316. """Send uvicorn's own loggers to bambuddy.log as well.
  317. Neither reaches the root handler: uvicorn.access has propagate=False, and
  318. uvicorn.error propagates only to "uvicorn", which has propagate=False.
  319. uvicorn.access is the record of which endpoint changed server state;
  320. uvicorn.error is where an unhandled route error is logged with its
  321. traceback ("Exception in ASGI application").
  322. """
  323. for name in ("uvicorn.access", "uvicorn.error"):
  324. logging.getLogger(name).addHandler(handler)
  325. # File handler - only in production or if explicitly enabled
  326. if app_settings.log_to_file:
  327. log_file = app_settings.log_dir / "bambuddy.log"
  328. file_handler = RotatingFileHandler(
  329. log_file,
  330. maxBytes=app_settings.log_max_bytes,
  331. backupCount=app_settings.log_backup_count,
  332. encoding="utf-8",
  333. )
  334. file_handler.setLevel(log_level)
  335. file_handler.setFormatter(logging.Formatter(log_format))
  336. file_handler.addFilter(_trace_id_filter)
  337. file_handler.addFilter(_refused_header_filter)
  338. root_logger.addHandler(file_handler)
  339. logging.info("Logging to file: %s", log_file)
  340. # Pipe uvicorn's HTTP access log to bambuddy.log too. Uvicorn ships its
  341. # access logger with propagate=False by default, so without this attach
  342. # there is no on-disk record of which endpoint triggered a server-state
  343. # change — the rogue stop_print mystery on 2026-04-26 was untraceable
  344. # for exactly this reason. Filtered to write methods only
  345. # (POST/PUT/PATCH/DELETE) so the high-volume status-poll GETs from the
  346. # frontend don't churn the rotation window faster than it's useful.
  347. from backend.app.core.logging_filters import (
  348. CancelledPoolNoiseFilter,
  349. WriteRequestsOnlyFilter,
  350. )
  351. _attach_file_handler_to_uvicorn(file_handler)
  352. uvicorn_access_logger = logging.getLogger("uvicorn.access")
  353. uvicorn_access_logger.addFilter(WriteRequestsOnlyFilter())
  354. # Uvicorn's access logger has propagate=False (its own default), so the
  355. # root-attached TraceIDFilter never sees these records. Attach a
  356. # second instance directly so HTTP access lines carry the same trace
  357. # ID column as the application logs they correlate with.
  358. uvicorn_access_logger.addFilter(TraceIDFilter())
  359. # Drop SQLAlchemy connection-pool log noise that's caused by Starlette's
  360. # BaseHTTPMiddleware cancelling the inner task scope on client
  361. # disconnect (#1112). The cancel-safe `get_db` already prevents the
  362. # underlying transaction leak; this filter only suppresses the residual
  363. # log records that pre-existing pools still emit during their cleanup.
  364. logging.getLogger("sqlalchemy.pool").addFilter(CancelledPoolNoiseFilter())
  365. # Query-string tokens out of uvicorn's request and WebSocket lines, on every
  366. # handler (console included), whether or not file logging is on.
  367. from backend.app.core.logging_filters import ( # noqa: E402
  368. QueryTokenRedactFilter,
  369. ShutdownCancelledRequestFilter,
  370. )
  371. # First, so the traceback of a stream cancelled at shutdown is dropped before
  372. # the filters below render it.
  373. logging.getLogger("uvicorn.error").addFilter(ShutdownCancelledRequestFilter())
  374. for _uvicorn_logger in ("uvicorn.access", "uvicorn.error"):
  375. logging.getLogger(_uvicorn_logger).addFilter(QueryTokenRedactFilter())
  376. logging.getLogger(_uvicorn_logger).addFilter(_refused_header_filter)
  377. # These stay at WARNING even in debug mode: at INFO/DEBUG httpx/httpcore log
  378. # full request URLs, and some carry credentials (bot tokens, webhook URLs, API
  379. # keys in the query). Same as the runtime log-level toggle in support.py.
  380. logging.getLogger("httpcore").setLevel(logging.WARNING)
  381. logging.getLogger("httpx").setLevel(logging.WARNING)
  382. # aiosqlite logs every statement with its parameters at DEBUG.
  383. logging.getLogger("aiosqlite").setLevel(logging.WARNING)
  384. # Reduce noise from third-party libraries in production
  385. if not app_settings.debug:
  386. logging.getLogger("sqlalchemy.engine").setLevel(logging.WARNING)
  387. logging.getLogger("paho.mqtt").setLevel(logging.WARNING)
  388. logging.info("Bambuddy starting - debug=%s, log_level=%s", app_settings.debug, log_level_str)
  389. # Track active prints: {(printer_id, filename): archive_id}
  390. _active_prints: dict[tuple[int, str], int] = {}
  391. # #1721: stage-22 pre-captured finish photo bytes per printer. on_finish_photo_moment
  392. # fires when stg_cur enters 22 ("Filament unloading") at end-of-print — toolhead
  393. # parked, bed not yet dropped — and grabs a single camera frame into this cache.
  394. # `_background_finish_photo` (inside on_print_complete) consumes the cached bytes
  395. # instead of running its own grab-now chain when present, so the finish photo
  396. # captures the better-framed pre-bed-drop moment without us having to force
  397. # timelapse on at dispatch (the #1397 mechanism that caused #1721's per-layer
  398. # nozzle parking on slicer profiles with Timelapse Type = Smooth).
  399. #
  400. # #2708: the bytes in here are ALWAYS already rotated by the printer's
  401. # camera_rotation. `on_finish_photo_moment` owns that, because one of its
  402. # sources (the #1867 in-print bank) is rotated before it ever reaches the
  403. # bank and the others are not — so the consumer can't tell them apart and
  404. # must not rotate again.
  405. _stage22_finish_frames: dict[int, bytes] = {}
  406. # #1790: per-printer producer-done event. Set by `on_finish_photo_moment` in its
  407. # `finally` block (whether it captured a frame or not). The consumer in
  408. # `_background_finish_photo` waits on it before reading `_stage22_finish_frames`
  409. # so the FINISH-state fallback path — where moment and completion are dispatched
  410. # back-to-back — doesn't race past the producer with an empty pop, and the
  411. # consumer's RTSP fallback can't collide with the producer's still-in-flight RTSP
  412. # grab (Bambu printers allow only one RTSP client at a time).
  413. _stage22_finish_in_flight: dict[int, asyncio.Event] = {}
  414. # #1867: rolling "last in-print camera frame" per printer. Refreshed on
  415. # layer-change and on print-progress advances (#2547) while the model is still
  416. # printing, then consumed by the FINISH-state finish-photo path when the
  417. # dispatcher recorded that it injected End G-code into this print. Bambu
  418. # reports gcode_state=FINISH AFTER the user End G-code (e.g. SwapMod
  419. # plate-swap) has run, so a live grab there would capture the swapped/empty
  420. # plate.
  421. #
  422. # The load-bearing property: both drivers are print telemetry that stops before
  423. # the End G-code executes — no further layer_num increases, and mc_percent
  424. # freezes — so the last banked frame is always the finished print before the
  425. # swap. Anything added as a third driver must hold that same property.
  426. _inprint_frame_bank: dict[int, bytes] = {}
  427. # Monotonic timestamp of the last banked frame per printer — throttles banking
  428. # so tall prints don't add a camera grab on every layer.
  429. _inprint_frame_bank_ts: dict[int, float] = {}
  430. # Minimum seconds between banked frames, except the final object layer which
  431. # always refreshes for the best framing.
  432. _INPRINT_BANK_MIN_INTERVAL = 25.0
  433. # Per-printer "connected" edge tracker. Used by `on_printer_status_change`
  434. # to fire `reconcile_stale_active_prints` exactly once per (re)connection
  435. # (#1542 follow-up — power-cycle ghost prints). The value is True after
  436. # the first connected status update for that connection; transitions back
  437. # to False whenever we observe `state.connected = False` so the next
  438. # reconnect re-arms reconciliation. Keyed by printer_id.
  439. _printer_reconciled_since_connect: dict[int, bool] = {}
  440. # Same edge, same keying, for priming the printer's calibration table exactly
  441. # once per (re)connection. Nothing else asks for it on connect: state.kprofiles
  442. # is otherwise filled only when someone opens the Profiles page or Configure
  443. # Slot, when a GitHub backup runs, or when the printer happens to answer
  444. # somebody else's query on the report topic. Until then the AMS slot card has
  445. # no K value to show on the printers whose trays carry none of their own
  446. # (#2854 — H2-series report cali_idx and nothing more).
  447. _printer_kprofiles_primed_since_connect: dict[int, bool] = {}
  448. # Track expected prints from reprint/scheduled (skip auto-archiving for these)
  449. # {(printer_id, filename): archive_id}
  450. _expected_prints: dict[tuple[int, str], int] = {}
  451. # Archives of the running prints Bambuddy dispatched itself: adopted from an
  452. # expected print, or found with Bambuddy's dispatch marker. _active_prints holds
  453. # every print on_print_start archived, those started from Bambu Studio, Handy or
  454. # the printer's screen included, so it is no proof of ownership on its own.
  455. _owned_print_archive_ids: set[int] = set()
  456. # Track AMS mapping for prints: {archive_id: [global_tray_id_per_slot]}
  457. # Used by usage tracker to map 3MF slots to physical AMS trays
  458. _print_ams_mappings: dict[int, list[int]] = {}
  459. # Track cost center selection for the current print run: {archive_id: cost_center_id}
  460. _print_cost_center_ids: dict[int, int] = {}
  461. # Track plate_id for prints from multi-plate 3MFs: {archive_id: plate_id}
  462. # Used by usage tracker to scope 3MF parsing to the dispatched plate (#1697).
  463. # Populated by direct-Print and queue dispatch paths; queue prints also have a
  464. # redundant queue-item lookup in on_print_start so this dict isn't load-bearing
  465. # for the queue path. Cleared on print completion or TTL eviction.
  466. _print_plate_ids: dict[int, int] = {}
  467. # Track progress milestones for notifications: {printer_id: last_milestone_notified}
  468. # Milestones are 25, 50, 75. Value of 0 means no milestone notified yet for current print.
  469. _last_progress_milestone: dict[int, int] = {}
  470. # Track whether first layer complete notification has been sent for current print
  471. _first_layer_notified: dict[int, bool] = {}
  472. # Track whether we already sent a kill-switch stop for the current unauthorized print
  473. _unauthorized_print_kill_sent: set[int] = set()
  474. # The MQTT status callback is a hot path. Cache the two-setting kill-switch
  475. # lookup briefly so an unknown active print does not query the database on
  476. # every status frame. A short TTL keeps settings changes responsive.
  477. _KILL_SWITCH_SETTING_CACHE_TTL_SECONDS = 5.0
  478. _kill_switch_setting_cache: tuple[bool, float] | None = None
  479. # Provider notification started when the kill switch stops a print. The later
  480. # MQTT print-complete callback awaits this task and only sends its regular
  481. # provider notification when the immediate attempt failed.
  482. _kill_switch_notification_tasks: dict[int, asyncio.Task[bool]] = {}
  483. # HMS faults already notified, with when each was last seen:
  484. # {printer_id: {fault key: timestamp}}. Tracked per fault, not per printer: a
  485. # fault that flickers beside a held notice was forgotten on every gap and
  486. # notified on every return (#3226). The window is long because the measured
  487. # gaps reach 64 s.
  488. _notified_hms_errors: dict[int, dict[str, float]] = {}
  489. _HMS_CLEAR_GRACE_SECONDS = 600.0
  490. # The print state each printer was last seen in, and the faults recorded before
  491. # it last changed, which are forgotten as soon as they are gone (see
  492. # _take_new_hms_faults).
  493. _hms_print_state: dict[int, str] = {}
  494. _hms_forget_when_gone: dict[int, set[str]] = {}
  495. # Track timelapse file baselines at print start: {printer_id: set of video filenames}
  496. # Used for snapshot-diff detection at print completion
  497. _timelapse_baselines: dict[int, set[str]] = {}
  498. # Track printers waiting for bed to cool after print completion.
  499. # Event-driven: fires when bed_temper arrives via MQTT below threshold.
  500. # {printer_id: {"threshold": float, "filename": str, "registered_at": float}}
  501. _bed_cool_waiters: dict[int, dict] = {}
  502. # Track printers where the user explicitly stopped the print from the queue UI.
  503. # When on_print_complete fires with status "failed" for these printers we treat it
  504. # as "cancelled" (stopped by user) so the correct notification email is sent.
  505. _user_stopped_printers: set[int] = set()
  506. # Printers whose running print the kill switch stopped. Their completion is a
  507. # cancel with the reason "killSwitch", not the "failed" the printer reports.
  508. _kill_switch_stopped: set[int] = set()
  509. # Offline-notification edge state (#1752): fire `on_printer_offline` exactly
  510. # once when a printer transitions connected → disconnected. `_printer_last_connected`
  511. # holds the previous observation so we only fire on the True → False edge (a
  512. # False → False repeat doesn't notify; an initial False at startup doesn't
  513. # notify either, since there's no prior True). `_printer_offline_notify_tasks`
  514. # holds the per-printer pending asyncio task that fires the notification
  515. # after a debounce window — cancelled if the printer reconnects before the
  516. # window elapses, so transient MQTT blips don't flood the user.
  517. _printer_last_connected: dict[int, bool] = {}
  518. # Printers whose relay offline event went out, so the reconnect publishes the
  519. # matching online event and a blip shorter than the debounce publishes neither.
  520. _printer_offline_published: set[int] = set()
  521. _printer_offline_notify_tasks: dict[int, asyncio.Task] = {}
  522. # Debounce: a printer must stay offline this long before we notify. Sized
  523. # against the staleness path (`bambu_mqtt.py::STALE_RECONNECT_COOLDOWN = 30s`)
  524. # so a single stale-trigger cooldown isn't enough to fire — only a real
  525. # offline that survives one reconnect attempt notifies.
  526. _PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS = 60.0
  527. # HMS short-code → failure_reason key. Used by _dispatch_archive_update
  528. # when status="failed" to label the print's failure_reason in archives.
  529. #
  530. # Earlier code matched on `module` alone (e.g. "any module 0x0C HMS → Layer shift"),
  531. # which is wrong on two counts:
  532. # 1. Real layer-shift codes live in module 0x03 (see Bambu wiki), not 0x0C.
  533. # 2. Module 0x0C is "Motion Controller" — broad category that also covers cameras
  534. # and visual markers, AND the H2D firmware emits a 0x0C HMS (0C00_001B, not in
  535. # the public wiki) as part of its user-cancel sequence. Matching on the module
  536. # alone caused user-cancellations to be archived as "Layer shift" failures.
  537. # We now match by full short code only — anything not in this map leaves
  538. # failure_reason=None rather than guessing.
  539. # Values are the canonical camelCase failure-reason keys, NOT display labels
  540. # (issue #2974). The vocabulary is enforced on writes by
  541. # ``_FAILURE_REASON_KEYS`` in ``api/routes/print_log.py`` and rendered through
  542. # ``t('editArchive.failureReasons.<key>')`` on both the archive editor and the
  543. # Statistics breakdown. Storing a label here instead put a second spelling of
  544. # the same cause into one column: the Failure Analysis widget groups on the raw
  545. # value, so a print the backend classified and an identical one a user
  546. # classified counted as two different reasons, and the label form could never
  547. # be translated because there was no key for ``t()`` to resolve.
  548. _HMS_FAILURE_REASONS: dict[str, str] = {
  549. # Layer shift / step loss
  550. "0300_4057": "layerShift",
  551. "0300_4068": "layerShift",
  552. "0300_800C": "layerShift",
  553. # Filament runout (printer-side & per-AMS-slot)
  554. "0300_8004": "filamentRunout",
  555. "0700_8011": "filamentRunout",
  556. "0701_8011": "filamentRunout",
  557. "0702_8011": "filamentRunout",
  558. "0703_8011": "filamentRunout",
  559. "0704_8011": "filamentRunout",
  560. "0705_8011": "filamentRunout",
  561. "0706_8011": "filamentRunout",
  562. "0707_8011": "filamentRunout",
  563. "07FF_8011": "filamentRunout",
  564. # Clogged nozzle / extruder
  565. "0300_4006": "cloggedNozzle",
  566. "0300_8016": "cloggedNozzle",
  567. "0300_801C": "cloggedNozzle",
  568. "0700_8003": "cloggedNozzle",
  569. "0700_8007": "cloggedNozzle",
  570. "0700_8013": "cloggedNozzle",
  571. "0701_8003": "cloggedNozzle",
  572. "0701_8007": "cloggedNozzle",
  573. "0701_8013": "cloggedNozzle",
  574. "0702_8003": "cloggedNozzle",
  575. # AI print monitoring — spaghetti / the model coming off the plate.
  576. # `spaghettiDetached` is a key the archive editor already offers for this
  577. # failure mode, not a new one, so a derived reason opens the dropdown on
  578. # that option rather than blank — and survives the next save, which clears
  579. # any value the editor does not recognise.
  580. #
  581. # A module-0x0C row is safe here despite the warning above: that warning is
  582. # about matching on the module alone, and 0C00_8042 is a full short code
  583. # with a documented meaning ("The AI print monitor has detected a spaghetti
  584. # defect", hms_errors.py). The H2D cancel echo is 0C00_001B, so the two
  585. # cannot collide.
  586. #
  587. # 0300_8003's own text ends "before continuing your print", but on an X2D
  588. # it arrives with the print already paused, offering only
  589. # RESUME_PRINTING_DEFECTS / STOP_PRINTING — a halt waiting on the user.
  590. #
  591. # Two neighbours are left out on purpose, so this does not get re-derived:
  592. # * 0C00_C004 "Possible spaghetti failure was detected." — "possible"
  593. # reads as a warning about a print that is still running, not a halt.
  594. # * 0300_800A is AI monitoring too, but it reports a filament pile-up in
  595. # the waste chute. That is not the print failing.
  596. #
  597. # That line is drawn from the text, not from `severity`, because severity
  598. # cannot draw it: 0300_8003 reaches us through `print_error`, a bare
  599. # module/error word with no level in it, and bambu_mqtt.py gives every
  600. # print_error entry a flat severity=3. Matching on the short code alone is
  601. # the right shape for derive_failure_reason, not an omission.
  602. "0300_8003": "spaghettiDetached",
  603. "0C00_8042": "spaghettiDetached",
  604. }
  605. def _hms_short_code(attr: int, code: int | str) -> str:
  606. """Build the canonical "MMMM_CCCC" HMS short code from raw attr/code values."""
  607. if isinstance(code, str):
  608. code_int = int(code.replace("0x", ""), 16) if code else 0
  609. else:
  610. code_int = int(code or 0)
  611. attr_int = int(attr or 0)
  612. return f"{(attr_int >> 16) & 0xFFFF:04X}_{code_int & 0xFFFF:04X}"
  613. def derive_failure_reason(status: str, hms_errors: list[dict] | None) -> str | None:
  614. """Derive the failure_reason key for an archived print.
  615. Returns "userCancelled" for cancelled/aborted prints; for failed prints,
  616. returns the first matching key from _HMS_FAILURE_REASONS, or None when
  617. no HMS code matches (don't guess — null is honest). The keys are the
  618. archive editor's vocabulary (_FAILURE_REASON_KEYS in print_log.py) and are
  619. translated at render time.
  620. """
  621. if status in ("aborted", "cancelled"):
  622. return "userCancelled"
  623. if status != "failed":
  624. return None
  625. for err in hms_errors or []:
  626. short_code = _hms_short_code(err.get("attr", 0), err.get("code", 0))
  627. if short_code in _HMS_FAILURE_REASONS:
  628. return _HMS_FAILURE_REASONS[short_code]
  629. return None
  630. # Track created_by_id for expected prints so the user email can be sent even when
  631. # the archive itself doesn't have created_by_id set (e.g. library-file-based prints).
  632. # {(printer_id, filename): created_by_id}
  633. _expected_print_creators: dict[tuple[int, str], int] = {}
  634. # Per-printer lock that serialises the spool-assignment side of on_ams_change
  635. # (auto-unlink stale + auto-assign new) when MQTT bursts deliver multiple AMS
  636. # updates for the same printer in quick succession (~30 ms apart, observed in
  637. # the wild on H2D + dual AMS).
  638. #
  639. # Without this serialisation, two concurrent on_ams_change callbacks each read
  640. # "no assignment for (printer, ams, tray)", each call auto_assign_spool, and
  641. # the second commit hits
  642. # IntegrityError: duplicate key value violates unique constraint
  643. # "spool_assignment_printer_id_ams_id_tray_id_key"
  644. # SQLite's WAL serial-write semantics had been silently swallowing the race
  645. # until optional Postgres support landed (asyncpg allows true concurrent
  646. # transactions and surfaces the constraint violation).
  647. #
  648. # Scope is intentionally narrow: only the two DB-mutating blocks (unlink +
  649. # assign) are inside the lock. The Spoolman sync block further down stays
  650. # concurrent because it's network-bound and idempotent.
  651. _ams_assignment_locks: dict[int, asyncio.Lock] = {}
  652. def _get_ams_assignment_lock(printer_id: int) -> asyncio.Lock:
  653. """Return the per-printer assignment lock, creating it on first use."""
  654. lock = _ams_assignment_locks.get(printer_id)
  655. if lock is None:
  656. lock = asyncio.Lock()
  657. _ams_assignment_locks[printer_id] = lock
  658. return lock
  659. # Per-printer dedup for unknown_tag WS broadcasts. Keyed by
  660. # (ams_id, tray_id) -> (tag_uid, tray_uuid); we only re-broadcast when the
  661. # tag tuple changes for the slot. Cleared when the slot is reported empty
  662. # so remove + reinsert reliably re-prompts the UI.
  663. _unknown_tag_last_broadcast: dict[int, dict[tuple[int, int], tuple[str, str]]] = {}
  664. async def _broadcast_unknown_tag(
  665. *,
  666. printer_id: int,
  667. ams_id: int,
  668. tray_id: int,
  669. tag_uid: str,
  670. tray_uuid: str,
  671. tray_type: str | None = None,
  672. tray_color: str | None = None,
  673. tray_sub_brands: str | None = None,
  674. tray_count: int | None = None,
  675. ) -> None:
  676. """Broadcast unknown_tag, deduped so repeated MQTT pushes for the same slot+tag don't spam the UI."""
  677. _logger = logging.getLogger(__name__)
  678. slot_key = (ams_id, tray_id)
  679. tag_key = (tag_uid or "", tray_uuid or "")
  680. per_printer = _unknown_tag_last_broadcast.setdefault(printer_id, {})
  681. if per_printer.get(slot_key) == tag_key:
  682. _logger.debug(
  683. "unknown_tag deduped for printer=%d AMS=%d slot=%d tag=%s",
  684. printer_id,
  685. ams_id,
  686. tray_id,
  687. tag_key[0][:8] or tag_key[1][:8] or "(none)",
  688. )
  689. return
  690. _logger.info(
  691. "unknown_tag broadcast: printer=%d AMS=%d slot=%d type=%r color=%r tag=%s",
  692. printer_id,
  693. ams_id,
  694. tray_id,
  695. tray_type,
  696. tray_color,
  697. tag_key[0][:8] or tag_key[1][:8] or "(none)",
  698. )
  699. # Broadcast first; only commit the dedup if the WS write succeeds.
  700. # If broadcast raises, the next MQTT push retries instead of being
  701. # permanently silenced by a poisoned dedup entry.
  702. await ws_manager.broadcast(
  703. {
  704. "type": "unknown_tag",
  705. "printer_id": printer_id,
  706. "ams_id": ams_id,
  707. "tray_id": tray_id,
  708. "tag_uid": tag_uid,
  709. "tray_uuid": tray_uuid,
  710. "tray_type": tray_type,
  711. "tray_color": tray_color,
  712. "tray_sub_brands": tray_sub_brands,
  713. "tray_count": tray_count,
  714. }
  715. )
  716. per_printer[slot_key] = tag_key
  717. def _clear_unknown_tag_dedup(printer_id: int, ams_id: int, tray_id: int) -> None:
  718. """Drop the cached last-broadcast tag for a slot (called when slot reports empty or gets matched)."""
  719. per_printer = _unknown_tag_last_broadcast.get(printer_id)
  720. if per_printer is None:
  721. return
  722. per_printer.pop((ams_id, tray_id), None)
  723. # TTL for expected-print entries: evict registrations older than this to prevent
  724. # unbounded growth when a print is registered but never starts (e.g. printer
  725. # disconnect, app restart, print started from the printer panel).
  726. _EXPECTED_PRINT_TTL_SECONDS: int = 2 * 60 * 60 # 2 hours
  727. # Registration timestamps used for TTL eviction: {(printer_id, filename): monotonic_time}
  728. _expected_print_registered_at: dict[tuple[int, str], float] = {}
  729. # Cleanup loop interval
  730. _EXPECTED_PRINT_CLEANUP_INTERVAL: int = 15 * 60 # 15 minutes
  731. _expected_prints_cleanup_task: asyncio.Task | None = None
  732. _ACTIVE_PRINT_STATES: set[str] = {"RUNNING", "PRINTING", "PAUSE"}
  733. def _build_status_print_keys(printer_id: int, state: PrinterState) -> list[tuple[int, str]]:
  734. """Build filename keys for matching a printer status update to Bambuddy-owned jobs."""
  735. possible_keys: list[tuple[int, str]] = []
  736. filename = (state.gcode_file or state.current_print or "").strip()
  737. subtask_name = (state.subtask_name or "").strip()
  738. if subtask_name:
  739. possible_keys.append((printer_id, subtask_name))
  740. possible_keys.append((printer_id, f"{subtask_name}.3mf"))
  741. possible_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
  742. if filename:
  743. base_name = filename.rsplit("/", 1)[-1]
  744. if base_name.endswith(".gcode.3mf"):
  745. root_name = base_name[: -len(".gcode.3mf")]
  746. possible_keys.append((printer_id, root_name))
  747. possible_keys.append((printer_id, base_name))
  748. possible_keys.append((printer_id, f"{root_name}.gcode"))
  749. possible_keys.append((printer_id, f"{root_name}.3mf"))
  750. elif base_name.endswith(".3mf"):
  751. root_name = base_name[: -len(".3mf")]
  752. possible_keys.append((printer_id, root_name))
  753. possible_keys.append((printer_id, base_name))
  754. elif base_name.endswith(".gcode"):
  755. root_name = base_name[: -len(".gcode")]
  756. possible_keys.append((printer_id, root_name))
  757. possible_keys.append((printer_id, f"{root_name}.3mf"))
  758. possible_keys.append((printer_id, base_name))
  759. else:
  760. possible_keys.append((printer_id, base_name))
  761. possible_keys.append((printer_id, f"{base_name}.3mf"))
  762. return possible_keys
  763. async def _print_user_id_if_still_there(db, print_user: dict | None) -> int | None:
  764. """The id of who started the print, unless that user has been deleted since.
  765. Deleting a user forgets them in printer_manager, but a print that ended a
  766. moment before still holds them.
  767. """
  768. if not print_user or print_user.get("user_id") is None:
  769. return None
  770. from backend.app.models.user import User
  771. return await db.scalar(select(User.id).where(User.id == print_user["user_id"]))
  772. def _is_bambuddy_authorized_print_in_memory(printer_id: int, state: PrinterState) -> bool:
  773. """Check the cheap, process-local print ownership signals."""
  774. if printer_manager.get_current_print_user(printer_id):
  775. return True
  776. return any(
  777. key in _expected_prints or _active_prints.get(key) in _owned_print_archive_ids
  778. for key in _build_status_print_keys(printer_id, state)
  779. )
  780. def _bind_active_print(
  781. printer_id: int,
  782. archive_id: int,
  783. archive_filename: str | None,
  784. filename: str | None = None,
  785. subtask_name: str | None = None,
  786. ) -> None:
  787. """Track a running print under every name its completion may report.
  788. One set for every path that binds a print (new archive, expected print,
  789. restart resume, fallback): the archive's file name, the name the printer
  790. reported, and the subtask with and without ``.3mf``. Paths that registered
  791. fewer names lost the bound archive at completion, and with it the plate
  792. restore's height (#3240), whenever MQTT reported a name they had left out.
  793. """
  794. for name in {archive_filename, filename, f"{subtask_name}.3mf" if subtask_name else None, subtask_name}:
  795. if name:
  796. _active_prints[(printer_id, name)] = archive_id
  797. def _mark_owned_if_dispatched(archive) -> None:
  798. """Remember a running print's archive as Bambuddy's when it carries a
  799. dispatch marker Bambuddy writes itself: ``billing_run_id`` (minted per
  800. dispatch in the scheduler) or ``created_by_id`` (from the queue item)."""
  801. if archive.billing_run_id is not None or archive.created_by_id is not None:
  802. _owned_print_archive_ids.add(archive.id)
  803. async def _is_printer_kill_switch_enabled_cached() -> bool:
  804. """Return the kill-switch setting without querying on every MQTT frame."""
  805. global _kill_switch_setting_cache
  806. now = time.monotonic()
  807. if _kill_switch_setting_cache is not None:
  808. enabled, expires_at = _kill_switch_setting_cache
  809. if now < expires_at:
  810. return enabled
  811. async with async_session() as db:
  812. from backend.app.services.finance_budget import is_printer_kill_switch_enabled
  813. enabled = await is_printer_kill_switch_enabled(db)
  814. _kill_switch_setting_cache = (enabled, now + _KILL_SWITCH_SETTING_CACHE_TTL_SECONDS)
  815. return enabled
  816. async def _is_bambuddy_authorized_print(printer_id: int, state: PrinterState, db) -> bool | None:
  817. """Resolve whether the current print was started by Bambuddy.
  818. ``None`` means identity is not yet safe to decide. The kill switch must
  819. defer in that case: stopping a print is irreversible, and the first status
  820. frames after a restart may arrive before all subtask fields are populated.
  821. """
  822. if _is_bambuddy_authorized_print_in_memory(printer_id, state):
  823. return True
  824. # The printer's built-in calibration runs (Bambuddy's Calibrate, the
  825. # printer's screen) play gcode from its read-only system partition, where no
  826. # user file can be. Only that path counts: a calibration *name* proves
  827. # nothing, since Bambu Studio's pressure-advance print reports a user-style
  828. # path, and any print can be given that name.
  829. if str(getattr(state, "gcode_file", "") or "").startswith("/usr/"):
  830. return True
  831. # A1, A1 Mini, P1 and A2L report the same calibration as a bare file name,
  832. # which nothing distinguishes from a user's file given that name, so it is
  833. # not exempt: with the kill switch on, calibrate on those printers with the
  834. # switch off.
  835. possible_keys = _build_status_print_keys(printer_id, state)
  836. # In-memory ownership is lost on every Bambuddy restart, so fall back to what
  837. # is on disk. subtask_id is minted per print and pins the answer to the job
  838. # actually running, rather than to an unrelated one that reuses a filename.
  839. raw_subtask_id = getattr(state, "subtask_id", None)
  840. subtask_id = str(raw_subtask_id).strip() if raw_subtask_id is not None else ""
  841. if subtask_id == "":
  842. # Not reported yet: the first frames after a restart can lack it.
  843. return None
  844. from backend.app.models.archive import PrintArchive
  845. if subtask_id == "0":
  846. # A print started outside the cloud from Bambu Studio, Handy or the
  847. # printer's screen reports "0", so there is no id to match: one of
  848. # Bambuddy's printing archives on this printer under the name the
  849. # printer reports, compared as the printer echoes names (spaces become
  850. # underscores). Nothing reported to compare yet: wait.
  851. reported = {_normalise_subtask_name(name) for _pid, name in possible_keys} - {""}
  852. if not reported:
  853. return None
  854. dispatched = await db.execute(
  855. select(PrintArchive)
  856. .where(
  857. PrintArchive.printer_id == printer_id,
  858. PrintArchive.status == "printing",
  859. or_(PrintArchive.billing_run_id.is_not(None), PrintArchive.created_by_id.is_not(None)),
  860. # An archive with a real id of its own is a print that reported
  861. # one: a "0" print is not it, even under the same name (one whose
  862. # completion was missed would otherwise cover it).
  863. or_(PrintArchive.subtask_id.is_(None), PrintArchive.subtask_id.in_(("", "0"))),
  864. )
  865. .order_by(PrintArchive.created_at.desc())
  866. )
  867. archive = next((a for a in dispatched.scalars() if _archive_name_forms(a) & reported), None)
  868. else:
  869. result = await db.execute(
  870. select(PrintArchive)
  871. .where(
  872. PrintArchive.printer_id == printer_id,
  873. PrintArchive.status == "printing",
  874. PrintArchive.subtask_id == subtask_id,
  875. )
  876. .order_by(PrintArchive.created_at.desc())
  877. .limit(1)
  878. )
  879. archive = result.scalar_one_or_none()
  880. # An archive row on its own proves nothing: `on_print_start` archives every
  881. # print it observes, including ones started from Bambu Studio or Handy, and
  882. # stamps them with the same status and subtask_id. Authorizing on its mere
  883. # existence would disable the kill switch the moment the 3MF finishes
  884. # downloading. Only a dispatch marker Bambuddy writes itself counts —
  885. # `billing_run_id` (minted per dispatch in the scheduler) or `created_by_id`
  886. # (carried over from the queue item that started it).
  887. if archive is not None and (archive.billing_run_id is not None or archive.created_by_id is not None):
  888. # Rehydrate the fast in-memory path for subsequent status frames. Include
  889. # both the archive filename and every normalized key reported by MQTT.
  890. _owned_print_archive_ids.add(archive.id)
  891. _active_prints[(printer_id, archive.filename)] = archive.id
  892. for key in possible_keys:
  893. _active_prints[key] = archive.id
  894. return True
  895. # No dispatch marker. Before calling this someone else's print, check whether
  896. # Bambuddy has a job of its own running on this printer: a library-file
  897. # dispatch has no archive at send time, and an archive created seconds later
  898. # by `on_print_start` carries neither marker. The queue row, which the
  899. # scheduler commits to status="printing" before the MQTT send, is the one
  900. # durable record every Bambuddy print has. It cannot be tied to this
  901. # subtask_id, so it is grounds to defer, never to authorize — stopping a
  902. # print is irreversible, and refusing to act costs nothing but a log line.
  903. from backend.app.models.print_queue import PrintQueueItem
  904. dispatched_here = await db.scalar(
  905. select(PrintQueueItem.id)
  906. .where(
  907. PrintQueueItem.printer_id == printer_id,
  908. PrintQueueItem.status == "printing",
  909. )
  910. .limit(1)
  911. )
  912. if dispatched_here is not None:
  913. return None
  914. return False
  915. async def _send_kill_switch_provider_notification(
  916. printer_id: int,
  917. printer_name: str,
  918. data: dict,
  919. ) -> bool:
  920. """Send the immediate print-stopped provider notification.
  921. Returning a success flag lets the normal MQTT completion path retry when
  922. this early notification could not be delivered.
  923. """
  924. logger = logging.getLogger(__name__)
  925. try:
  926. async with async_session() as db:
  927. await notification_service.on_print_complete(
  928. printer_id,
  929. printer_name,
  930. "stopped",
  931. data,
  932. db,
  933. )
  934. return True
  935. except Exception as e:
  936. logger.warning(
  937. "[KILL SWITCH] Immediate provider notification failed for printer %s: %s",
  938. printer_id,
  939. e,
  940. )
  941. return False
  942. async def _kill_switch_notification_already_sent(task: asyncio.Task[bool] | None) -> bool:
  943. """Wait for an immediate kill-switch notification, if one was scheduled."""
  944. if task is None:
  945. return False
  946. try:
  947. return await task
  948. except Exception as e:
  949. logging.getLogger(__name__).warning("[KILL SWITCH] Notification task failed: %s", e)
  950. return False
  951. async def _record_energy_start(archive, printer_id: int, db, *, context: str = "") -> bool:
  952. """Capture the smart plug lifetime counter on the archive at print start.
  953. Persists `energy_start_kwh` on the archive row (#941) so per-print energy
  954. tracking survives a backend restart mid-print. The print-end handler reads
  955. this value back from the DB and computes the delta against the current
  956. plug counter.
  957. """
  958. _logger = logging.getLogger(__name__)
  959. try:
  960. candidates = await energy_plug_candidates(db, printer_id)
  961. if not candidates:
  962. _logger.info("[ENERGY] No smart plug for printer %s (archive %s)", printer_id, archive.id)
  963. return False
  964. selected = await select_energy_reading(candidates, _get_plug_energy, db)
  965. if selected is None:
  966. # Naming the plugs matters here: with several linked to one printer
  967. # this is the difference between "the meter is offline" and "you
  968. # linked only accessories" (#2859).
  969. _logger.warning(
  970. "[ENERGY] No plug on printer %s reports a lifetime energy counter for archive %s (tried: %s)",
  971. printer_id,
  972. archive.id,
  973. ", ".join(plug.name for plug in candidates),
  974. )
  975. return False
  976. plug, energy = selected
  977. archive.energy_start_kwh = float(energy["total"])
  978. # With the plug's snapshots, what lets the cost follow the price over
  979. # the print rather than take the price at its end (#1251). A price that
  980. # can't be had must not cost the print its energy reading.
  981. archive.energy_start_at = utcnow_naive()
  982. archive.energy_start_plug_id = plug.id
  983. try:
  984. from backend.app.services.energy_price import current_price
  985. archive.energy_start_price = await current_price(db)
  986. except Exception as e:
  987. _logger.warning("[ENERGY] Could not read the electricity price for archive %s: %s", archive.id, e)
  988. archive.energy_start_price = None
  989. await db.commit()
  990. _logger.info(
  991. "[ENERGY] Recorded starting energy%s for archive %s from plug '%s': %s kWh",
  992. f" ({context})" if context else "",
  993. archive.id,
  994. plug.name,
  995. energy["total"],
  996. )
  997. return True
  998. except Exception as e:
  999. _logger.warning("[ENERGY] Failed to record starting energy for archive %s: %s", archive.id, e)
  1000. return False
  1001. def forget_print_creator(user_id: int) -> None:
  1002. """The print-start emails of a deleted user's jobs go to nobody, not to
  1003. whoever is given the id next (SQLite reuses it)."""
  1004. for key in [key for key, creator in _expected_print_creators.items() if creator == user_id]:
  1005. del _expected_print_creators[key]
  1006. async def forget_printer(printer_id: int) -> None:
  1007. """Drop what is kept for a deleted printer's id, here and in the services.
  1008. SQLite used to give the id to the next printer created, which inherited it
  1009. all: the running print's owner (its prints passed the kill switch and were
  1010. billed to that user), the plate-clear gate, pending and suppressed
  1011. notifications, the camera feed, the plate references. Ids are no longer
  1012. reused (AUTOINCREMENT), but nothing kept for a printer that is gone should
  1013. stay. Called after the delete is committed, and again by work that was in
  1014. flight and wrote state back.
  1015. Every printer-keyed map of this module is listed here or, with the reason,
  1016. in tests/unit/test_forget_printer.py.
  1017. """
  1018. from backend.app.api.routes import camera
  1019. from backend.app.services import (
  1020. bambu_ftp,
  1021. kprofile_drift,
  1022. layer_timelapse,
  1023. plate_detection,
  1024. print_dispatch_context,
  1025. usage_tracker,
  1026. )
  1027. from backend.app.services.notify_live_activities import notify_live_activities
  1028. from backend.app.services.obico_detection import obico_detection_service
  1029. from backend.app.services.printer_file_cache import printer_file_cache
  1030. # Keyed (printer_id, filename). The archive-keyed maps of those prints go too.
  1031. archive_ids = set()
  1032. for tracked in (_active_prints, _expected_prints):
  1033. for key in [key for key in tracked if key[0] == printer_id]:
  1034. archive_ids.add(tracked.pop(key))
  1035. for archive_id in archive_ids:
  1036. _owned_print_archive_ids.discard(archive_id)
  1037. _print_ams_mappings.pop(archive_id, None)
  1038. _print_cost_center_ids.pop(archive_id, None)
  1039. _print_plate_ids.pop(archive_id, None)
  1040. for tracked in (_expected_print_creators, _expected_print_registered_at):
  1041. for key in [key for key in tracked if key[0] == printer_id]:
  1042. del tracked[key]
  1043. for key in [key for key in _ams_index_only_logged if key[0] == printer_id]:
  1044. _ams_index_only_logged.discard(key)
  1045. for key in [key for key in _ams_alarm_cooldown if key.split(":", 1)[0] == str(printer_id)]:
  1046. del _ams_alarm_cooldown[key]
  1047. # Pending work that would act on the id: an offline notice, a 3MF retry.
  1048. # A kill-switch notice is about a stop that happened and is left to finish.
  1049. for tasks in (_printer_offline_notify_tasks, _fallback_3mf_retry_tasks):
  1050. task = tasks.pop(printer_id, None)
  1051. if task is not None:
  1052. task.cancel()
  1053. for keyed in (
  1054. _stage22_finish_frames,
  1055. _stage22_finish_in_flight,
  1056. _inprint_frame_bank,
  1057. _inprint_frame_bank_ts,
  1058. _printer_reconciled_since_connect,
  1059. _printer_kprofiles_primed_since_connect,
  1060. _last_progress_milestone,
  1061. _first_layer_notified,
  1062. _kill_switch_notification_tasks,
  1063. _notified_hms_errors,
  1064. _hms_print_state,
  1065. _hms_forget_when_gone,
  1066. _timelapse_baselines,
  1067. _bed_cool_waiters,
  1068. _printer_last_connected,
  1069. _unknown_tag_last_broadcast,
  1070. _last_status_broadcast,
  1071. _connection_watchdog_last_attempt,
  1072. ):
  1073. keyed.pop(printer_id, None)
  1074. for marked in (
  1075. _unauthorized_print_kill_sent,
  1076. _user_stopped_printers,
  1077. _kill_switch_stopped,
  1078. _printer_offline_published,
  1079. _nozzle_count_updated,
  1080. ):
  1081. marked.discard(printer_id)
  1082. printer_manager.forget_printer(printer_id)
  1083. printer_file_cache.forget_printer(printer_id)
  1084. print_dispatch_context.clear(printer_id)
  1085. kprofile_drift.forget_printer(printer_id, deleted=True)
  1086. layer_timelapse.cancel_session(printer_id)
  1087. usage_tracker.forget_printer(printer_id)
  1088. obico_detection_service.forget_printer(printer_id)
  1089. bambu_ftp.clear_3mf_cache(printer_id)
  1090. await camera.forget_printer(printer_id)
  1091. printers.clear_cover_cache(printer_id)
  1092. print_scheduler.forget_printer(printer_id)
  1093. notify_live_activities.forget_printer(printer_id)
  1094. plate_detection.remove_printer_references(printer_id)
  1095. def register_expected_print(
  1096. printer_id: int,
  1097. filename: str,
  1098. archive_id: int,
  1099. ams_mapping: list[int] | None = None,
  1100. created_by_id: int | None = None,
  1101. cost_center_id: int | None = None,
  1102. plate_id: int | None = None,
  1103. ):
  1104. """Register an expected print from reprint/scheduled so we don't create duplicate archives."""
  1105. # Store with multiple filename variations to catch different naming patterns
  1106. _expected_prints[(printer_id, filename)] = archive_id
  1107. # Also store without .3mf extension if present
  1108. if filename.endswith(".3mf"):
  1109. base = filename[:-4]
  1110. _expected_prints[(printer_id, base)] = archive_id
  1111. _expected_prints[(printer_id, f"{base}.gcode")] = archive_id
  1112. # Store AMS mapping for usage tracking at print completion
  1113. if ams_mapping is not None:
  1114. _print_ams_mappings[archive_id] = ams_mapping
  1115. if cost_center_id is not None:
  1116. _print_cost_center_ids[archive_id] = cost_center_id
  1117. # Store plate_id for usage tracking when this is a single-plate dispatch from
  1118. # a multi-plate 3MF — without this, the direct-Print path attributes the whole
  1119. # file's filament total to the spool instead of just the printed plate (#1697).
  1120. if plate_id is not None:
  1121. _print_plate_ids[archive_id] = plate_id
  1122. # Store created_by_id so the user start email can be sent even when the archive
  1123. # itself has no created_by_id (e.g. library-file-based queue prints)
  1124. if created_by_id is not None:
  1125. _expected_print_creators[(printer_id, filename)] = created_by_id
  1126. if filename.endswith(".3mf"):
  1127. base = filename[:-4]
  1128. _expected_print_creators[(printer_id, base)] = created_by_id
  1129. _expected_print_creators[(printer_id, f"{base}.gcode")] = created_by_id
  1130. # Record registration time for TTL-based eviction
  1131. _registered_at = time.monotonic()
  1132. _expected_print_registered_at[(printer_id, filename)] = _registered_at
  1133. if filename.endswith(".3mf"):
  1134. base = filename[:-4]
  1135. _expected_print_registered_at[(printer_id, base)] = _registered_at
  1136. _expected_print_registered_at[(printer_id, f"{base}.gcode")] = _registered_at
  1137. logging.getLogger(__name__).info(
  1138. f"Registered expected print: printer={printer_id}, file={filename}, archive={archive_id}, ams_mapping={ams_mapping}, plate_id={plate_id}"
  1139. )
  1140. def unregister_expected_print(printer_id: int, filename: str, archive_id: int) -> None:
  1141. """Undo :func:`register_expected_print` when the print never went out.
  1142. Registration has to happen *before* the MQTT print command, because the
  1143. printer can report the print before the line after the send executes. So
  1144. every path that registers and then fails to send — a cancel winning the
  1145. #1853 CAS race, a ``start_print()`` that returns False, or any exception in
  1146. between — leaves an expectation for a print that will never arrive.
  1147. The TTL sweep evicts those after two hours, which is far longer than it
  1148. takes a user to react to a failed dispatch by pressing print again: that
  1149. reprint would be folded into the *old* archive and take the stale
  1150. ``ams_mapping`` / ``plate_id`` with it. Hence the explicit inverse.
  1151. Mirrors the sweep's rules, including the one that is easy to get wrong:
  1152. ``_print_ams_mappings`` / ``_print_plate_ids`` / ``_print_cost_center_ids``
  1153. are keyed by archive, not by file, so they may only be dropped once no
  1154. live key still points at that archive.
  1155. """
  1156. keys = [(printer_id, filename)]
  1157. if filename.endswith(".3mf"):
  1158. base = filename[:-4]
  1159. keys.append((printer_id, base))
  1160. keys.append((printer_id, f"{base}.gcode"))
  1161. removed = False
  1162. for key in keys:
  1163. if _expected_prints.pop(key, None) is not None:
  1164. removed = True
  1165. _expected_print_creators.pop(key, None)
  1166. _expected_print_registered_at.pop(key, None)
  1167. if archive_id not in set(_expected_prints.values()):
  1168. _print_ams_mappings.pop(archive_id, None)
  1169. _print_cost_center_ids.pop(archive_id, None)
  1170. _print_plate_ids.pop(archive_id, None)
  1171. if removed:
  1172. logging.getLogger(__name__).info(
  1173. "Unregistered expected print: printer=%s, file=%s, archive=%s (print was never sent)",
  1174. printer_id,
  1175. filename,
  1176. archive_id,
  1177. )
  1178. def _compute_run_filament_grams(
  1179. status: str,
  1180. archive_filament_used_grams: float | None,
  1181. progress: float | int | None,
  1182. usage_results: list[dict] | None,
  1183. ) -> float | None:
  1184. """Per-run filament for PrintLogEntry, partial- and tracker-aware (#1378, #1390).
  1185. Priority for every status:
  1186. 1. Sum of tracked spool deltas in ``usage_results`` (AMS-measured
  1187. weight delta — same source that drives "Total Consumed" on the
  1188. Inventory page, so Stats and Inventory totals stay aligned).
  1189. 2. For ``completed``: the slicer estimate (no tracker available, fall
  1190. back to the canonical "this print used X" value).
  1191. 3. For partial statuses: ``estimate * progress%``.
  1192. 4. ``None`` if nothing is known.
  1193. """
  1194. tracked_grams = sum(r.get("weight_used") or 0 for r in (usage_results or []))
  1195. if tracked_grams > 0:
  1196. return round(tracked_grams, 1)
  1197. if status == "completed":
  1198. return archive_filament_used_grams
  1199. if archive_filament_used_grams:
  1200. scale = max(0.0, min(((progress or 0) / 100.0), 1.0))
  1201. if scale > 0:
  1202. return round(archive_filament_used_grams * scale, 1)
  1203. return None
  1204. def _get_start_ams_mapping(data: dict, archive_id: int | None) -> list[int] | None:
  1205. """Resolve AMS mapping for print start without consuming stored queue/reprint state."""
  1206. stored_ams_mapping = data.get("ams_mapping")
  1207. if not stored_ams_mapping and archive_id:
  1208. stored_ams_mapping = _print_ams_mappings.get(archive_id)
  1209. return stored_ams_mapping
  1210. def _get_start_plate_id(archive_id: int | None) -> int | None:
  1211. """Resolve plate_id for print start without consuming stored direct-Print state.
  1212. Direct-Print of a single plate from a multi-plate 3MF registers plate_id in
  1213. ``_print_plate_ids`` at dispatch time; this lets the spoolman / usage tracker
  1214. read it back at print-start without popping (the entry is popped on print
  1215. completion or TTL eviction, mirroring ``_print_ams_mappings``).
  1216. """
  1217. if archive_id is None:
  1218. return None
  1219. return _print_plate_ids.get(archive_id)
  1220. def _partial_progress_scale(progress: int | float | None) -> float:
  1221. """Clamp ``progress / 100`` into [0.0, 1.0] for partial-print scaling.
  1222. Used by every site that multiplies a "would-have-used" slicer estimate
  1223. down to "actually-used" for failed / cancelled / stopped prints. Centralised
  1224. so the three sites in ``_background_notifications`` (and the per-plate
  1225. override helper) can't drift apart on the coercion shape.
  1226. """
  1227. return max(0.0, min((progress or 0) / 100.0, 1.0))
  1228. def _scope_notification_archive_data_to_plate(
  1229. archive_data: dict,
  1230. archive_file_path: str | None,
  1231. plate_id: int | None,
  1232. print_status: str,
  1233. progress: int | float | None,
  1234. base_dir: Path,
  1235. ) -> dict:
  1236. """Override summed-across-plates totals in ``archive_data`` with the values
  1237. for ``plate_id`` so the completion notification reports what was actually
  1238. printed, not the whole project (#1785).
  1239. The 3MF parser at services/archive.py:200-264 sums ``prediction`` and
  1240. ``weight`` across every plate of a multi-plate file (#1593) — correct for
  1241. the archive card's "whole project" headline, wrong for the completion
  1242. notification of a single-plate print. The queue UI already re-reads the
  1243. 3MF per-plate at print_queue.py:272-285; this helper mirrors that for the
  1244. notification payload (filament grams, time estimate, per-slot breakdown).
  1245. No-ops when ``plate_id`` is None, the file is missing, or the 3MF carries
  1246. no per-plate values — in every fail case the original ``archive_data`` is
  1247. returned unchanged so the notification still sends.
  1248. """
  1249. if plate_id is None or not archive_file_path:
  1250. return archive_data
  1251. from backend.app.utils.threemf_tools import (
  1252. extract_filament_usage_from_3mf,
  1253. extract_print_time_from_3mf,
  1254. )
  1255. archive_path = base_dir / archive_file_path
  1256. if not archive_path.exists():
  1257. return archive_data
  1258. plate_slots = extract_filament_usage_from_3mf(archive_path, plate_id)
  1259. plate_grams = sum(f.get("used_g", 0) for f in plate_slots)
  1260. plate_time = extract_print_time_from_3mf(archive_path, plate_id)
  1261. scale = 1.0 if print_status == "completed" else _partial_progress_scale(progress)
  1262. if plate_time:
  1263. archive_data["print_time_seconds"] = plate_time
  1264. # Gate both the grams headline AND the per-slot breakdown on the same
  1265. # `plate_grams > 0` signal: if the 3MF carries per-plate filament rows but
  1266. # they all sum to zero (slicer bug / re-slice without estimate), drop back
  1267. # to the project-level grams the archive columns already provide rather
  1268. # than ship a project-level headline next to an all-zero per-plate
  1269. # breakdown.
  1270. if plate_grams > 0:
  1271. archive_data["actual_filament_grams"] = round(plate_grams * scale, 1)
  1272. archive_data["filament_slots"] = [
  1273. {
  1274. "slot_id": s.get("slot_id"),
  1275. "used_g": round((s.get("used_g") or 0) * scale, 1),
  1276. "type": s.get("type", ""),
  1277. "color": s.get("color", ""),
  1278. }
  1279. for s in plate_slots
  1280. ]
  1281. return archive_data
  1282. def _extract_filament_data_from_mqtt(data: dict, ams_mapping: list[int] | None = None) -> dict[str, str]:
  1283. """Best-effort filament metadata from the MQTT print-start snapshot.
  1284. Used when the 3MF can't be downloaded (P1S/A1/P2S firmwares lock the
  1285. file during print, see #1533) so the fallback PrintArchive still has
  1286. enough filament info to support the inventory views and AMS-expansion
  1287. planning the operator opens it for. Returns a dict with optional
  1288. ``filament_type`` and ``filament_color`` keys in the same
  1289. comma-separated format the 3MF extractor produces, so the rest of the
  1290. codebase treats the fallback archive identically to a normal one.
  1291. ``ams_mapping`` is the slicer's slot-per-print-filament list captured
  1292. from the MQTT print payload (global tray IDs, possibly -1 for VT-tray
  1293. entries). When supplied, only the slots actually consumed by this
  1294. print contribute. Without it the function falls back to every loaded
  1295. AMS slot — less accurate but still useful.
  1296. Accepts both the raw inner payload (``{"ams": {"ams": [...]}, ...}``)
  1297. that the unit tests pass directly, AND the on_print_start callback
  1298. shape (``{"raw_data": {"ams": {"ams": [...]}, ...}, ...}``) the
  1299. bambu_mqtt service hands to main.py at runtime. The original
  1300. ``_extract_filament_data_from_mqtt(data)`` shipped in #1533 only
  1301. handled the inner shape and silently returned ``{}`` for every real
  1302. print start, leaving fallback archives' filament fields NULL — the
  1303. exact regression the fix was meant to close. Reported with a log
  1304. proving the AMS state was right there at
  1305. ``data["raw_data"]["ams"]["ams"][0]["tray"][0]`` (#1533 follow-up).
  1306. """
  1307. result: dict[str, str] = {}
  1308. # Look at the on_print_start wrapper first, then the inner shape.
  1309. raw_data = (data or {}).get("raw_data")
  1310. ams_root = (raw_data or {}).get("ams") if isinstance(raw_data, dict) else None
  1311. if not isinstance(ams_root, dict):
  1312. ams_root = (data or {}).get("ams") or {}
  1313. ams_units = ams_root.get("ams") if isinstance(ams_root, dict) else None
  1314. if not isinstance(ams_units, list) or not ams_units:
  1315. return result
  1316. from backend.app.services.print_scheduler import _global_tray_id
  1317. # Map global tray id → (type, color), addressed as the print's ams_mapping
  1318. # is: unit * 4 + tray, or the bare unit id for an AMS-HT (from 128).
  1319. loaded: dict[int, tuple[str, str]] = {}
  1320. for unit in ams_units:
  1321. if not isinstance(unit, dict):
  1322. continue
  1323. try:
  1324. unit_id = int(unit.get("id", 0))
  1325. except (TypeError, ValueError):
  1326. continue
  1327. for tray in unit.get("tray") or []:
  1328. if not isinstance(tray, dict):
  1329. continue
  1330. try:
  1331. tray_id = int(tray.get("id", 0))
  1332. except (TypeError, ValueError):
  1333. continue
  1334. ttype = (tray.get("tray_type") or "").strip()
  1335. # RRGGBBAA from the printer, stored as the 3MF path stores it:
  1336. # "#RRGGBB" (the Archives page's swatches and colour filter).
  1337. hex_color = (tray.get("tray_color") or "").strip().upper()[:6]
  1338. tcolor = f"#{hex_color}" if re.fullmatch(r"[0-9A-F]{6}", hex_color) else ""
  1339. if not ttype:
  1340. continue # Empty / unloaded slot.
  1341. loaded[_global_tray_id(unit_id, tray_id)] = (ttype, tcolor)
  1342. if not loaded:
  1343. return result
  1344. if ams_mapping:
  1345. used_ids = [int(x) for x in ams_mapping if isinstance(x, (int, float)) and int(x) >= 0]
  1346. filaments = [loaded[g] for g in used_ids if g in loaded]
  1347. if not filaments:
  1348. return result # Mapping points entirely at slots we have no data for.
  1349. else:
  1350. filaments = [loaded[g] for g in sorted(loaded.keys())]
  1351. types_joined = ",".join(f[0] for f in filaments)
  1352. colors_joined = ",".join(f[1] for f in filaments if f[1])
  1353. # Column limits per backend/app/models/archive.py: filament_type=50,
  1354. # filament_color=200.
  1355. if types_joined:
  1356. result["filament_type"] = types_joined[:50]
  1357. if colors_joined:
  1358. result["filament_color"] = colors_joined[:200]
  1359. return result
  1360. def _maybe_start_layer_timelapse(printer, printer_id: int, archive_id: int) -> bool:
  1361. """Start a layer-timelapse session for *archive_id* when the printer has
  1362. an external camera configured. Returns True if a session was started.
  1363. Three call sites in on_print_start (expected-archive promotion, fallback
  1364. archive creation, fresh-archive creation) used to inline this same
  1365. if-block; the inline copies kept drifting (#1353 fixed only one of them
  1366. on the first pass). Centralising the conditional + call here makes the
  1367. contract testable in isolation and keeps the three sites locked in step.
  1368. """
  1369. if not (printer.external_camera_enabled and printer.external_camera_url):
  1370. return False
  1371. from backend.app.services.layer_timelapse import start_session
  1372. start_session(
  1373. printer_id,
  1374. archive_id,
  1375. printer.external_camera_url,
  1376. printer.external_camera_type or "mjpeg",
  1377. snapshot_url=printer.external_camera_snapshot_url,
  1378. rotation=getattr(printer, "camera_rotation", 0),
  1379. )
  1380. logging.getLogger(__name__).info("Started layer timelapse for printer %s, archive %s", printer_id, archive_id)
  1381. return True
  1382. def _format_hms_error_summary(hms_errors: list[dict]) -> str | None:
  1383. """Build a human-readable failure reason from MQTT hms_errors for PrintQueueItem.error_message.
  1384. Each entry has keys: code ('0x4038'), attr (32-bit int), module, severity, and
  1385. — since #2926 — the description the parser already resolved, which is preferred
  1386. when present so the queue's failure reason reads the same as the status
  1387. response. The short code still produces the bracketed label, and still
  1388. resolves the sentence for a caller whose entries predate the field. An entry
  1389. with a 16-char ``full_code`` is labelled with it instead, since the short code
  1390. of an ``hms[]`` fault is not a code anyone can look up. Falls back to the bare
  1391. label when no description is on file. Returns None for an empty list so
  1392. callers can leave error_message unset.
  1393. """
  1394. if not hms_errors:
  1395. return None
  1396. from backend.app.services.hms_errors import get_error_description
  1397. parts: list[str] = []
  1398. for err in hms_errors:
  1399. try:
  1400. # `_hms_short_code` rather than a local derivation: this one used to
  1401. # format the error without masking it to 16 bits, so an `hms[]` entry
  1402. # whose code carries an alert-level group produced a five-digit label
  1403. # like "0500_3000A" — not a code the user can look up, and never a
  1404. # catalogue key, so the sentence was lost with it.
  1405. short_code = _hms_short_code(err.get("attr", 0), err.get("code", 0))
  1406. except (TypeError, ValueError):
  1407. continue
  1408. description = err.get("description") or get_error_description(short_code)
  1409. # An `hms[]` fault's short code ("0500_000E") drops the part and level
  1410. # groups and is not a code anyone can look up; its full code in the
  1411. # printer screen's four groups is (#2728).
  1412. full_code = str(err.get("full_code") or "")
  1413. label = "-".join(full_code[i : i + 4] for i in range(0, 16, 4)) if len(full_code) == 16 else short_code
  1414. parts.append(f"[{label}] {description}" if description else f"[{label}]")
  1415. return "; ".join(parts) if parts else None
  1416. async def _bump_library_file_usage_if_completed(db, item, queue_status: str) -> None:
  1417. """Increment LibraryFile.print_count and stamp last_printed_at when a queued
  1418. print completes successfully. Gated to status=='completed': failed, cancelled
  1419. and aborted prints do not count as usage. Caller is responsible for committing
  1420. the session. No-op when the queue item has no linked library file (e.g. reprints
  1421. from an archive). See #1008."""
  1422. if queue_status != "completed" or item.library_file_id is None:
  1423. return
  1424. from backend.app.models.library import LibraryFile
  1425. lib_file = await db.scalar(select(LibraryFile).where(LibraryFile.id == item.library_file_id))
  1426. if lib_file is None:
  1427. return
  1428. lib_file.print_count = (lib_file.print_count or 0) + 1
  1429. lib_file.last_printed_at = datetime.now(timezone.utc)
  1430. def mark_printer_stopped_by_user(printer_id: int) -> None:
  1431. """Mark that the active print on this printer was stopped by the user from the queue UI.
  1432. When on_print_complete fires with status 'failed' for a printer in this set we
  1433. reclassify it as 'cancelled' so the correct 'print stopped' notification is sent
  1434. rather than a 'print failed' notification.
  1435. """
  1436. _user_stopped_printers.add(printer_id)
  1437. logging.getLogger(__name__).info("Marked printer %s as user-stopped from queue", printer_id)
  1438. _last_status_broadcast: dict[int, str] = {}
  1439. # Track printers where we've updated nozzle_count
  1440. _nozzle_count_updated: set[int] = set()
  1441. async def _maybe_notify_printer_offline(printer_id: int) -> None:
  1442. """Wait the debounce window then fire `on_printer_offline` if the printer
  1443. is still offline.
  1444. Scheduled by `on_printer_status_change` on the connected → disconnected
  1445. edge (#1752). Cancelled by the same handler if the printer reconnects
  1446. before the window elapses, so a single MQTT blip + recovery doesn't
  1447. notify. Both the staleness-detector path (`bambu_mqtt.py::check_staleness`)
  1448. and the smart-plug power-off path (`printer_manager.mark_printer_offline`)
  1449. route through the same status-change callback, so this covers both.
  1450. """
  1451. logger = logging.getLogger(__name__)
  1452. try:
  1453. await asyncio.sleep(_PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS)
  1454. still_offline = not printer_manager.is_connected(printer_id)
  1455. logger.info(
  1456. "[#1752] Printer %s offline debounce elapsed: still_offline=%s",
  1457. printer_id,
  1458. still_offline,
  1459. )
  1460. if not still_offline:
  1461. return
  1462. async with async_session() as db:
  1463. from backend.app.models.printer import Printer
  1464. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1465. printer = result.scalar_one_or_none()
  1466. if not printer:
  1467. logger.warning(
  1468. "[#1752] Printer %s missing from DB at offline-notify time; skipping",
  1469. printer_id,
  1470. )
  1471. return
  1472. # Recorded only when the relay can publish it, so the reconnect's
  1473. # online event always has an offline before it.
  1474. if mqtt_relay.enabled and mqtt_relay.connected:
  1475. _printer_offline_published.add(printer_id)
  1476. try:
  1477. await mqtt_relay.on_printer_offline(printer_id, printer.name, printer.serial_number)
  1478. except Exception as e:
  1479. logger.warning("MQTT relay offline event failed for printer %s: %s", printer_id, e)
  1480. logger.info(
  1481. "[#1752] Dispatching on_printer_offline for printer %s (%s)",
  1482. printer_id,
  1483. printer.name,
  1484. )
  1485. await notification_service.on_printer_offline(printer_id, printer.name, db)
  1486. except asyncio.CancelledError:
  1487. raise
  1488. except Exception as e:
  1489. logger.warning("Printer offline notification failed for printer %s: %s", printer_id, e)
  1490. finally:
  1491. _printer_offline_notify_tasks.pop(printer_id, None)
  1492. def _hms_notify_key(error) -> str:
  1493. """What identifies a fault for notification de-duplication.
  1494. The full code, which is unique per fault. ``attr`` alone used to be the key:
  1495. unique for a ``print_error``, but for an ``hms[]`` fault it is only the
  1496. module and part, so two faults on one part (#1840's H2C held 0500-0600-0002-0005
  1497. and -0006 together) shared a key and only the first was ever notified. An
  1498. entry without a full code falls back to attr and code together.
  1499. """
  1500. full_code = getattr(error, "full_code", "") or ""
  1501. if full_code:
  1502. return full_code.upper()
  1503. return f"{error.attr:08X}:{error.code}"
  1504. def _hms_fault_counts(error) -> bool:
  1505. """Whether a fault counts as a problem: the same rule the frontend's
  1506. ``filterKnownHMSErrors`` applies to the printer card, badge and camera wall.
  1507. It counts when Bambu publishes text for it or it offers action buttons, and
  1508. its level is a real one. An ``hms[]`` fault at level 3 (notification) with
  1509. no actions does not count: those are things like "the top cover is open" or
  1510. "the chamber is hot, fan speed increased", which a printer can hold through
  1511. a whole print. A ``print_error`` at the same level (0xCxxx) still counts, as
  1512. it always has; those are prompts such as "unable to start drying" (#2728).
  1513. """
  1514. if error.severity < 1:
  1515. return False
  1516. has_actions = bool(getattr(error, "actions", None))
  1517. is_hms_notice = len(getattr(error, "full_code", "") or "") == 16 and error.severity == 3
  1518. return has_actions or (bool(getattr(error, "description", None)) and not is_hms_notice)
  1519. def _hms_errors_to_notify(errors: list, new_error_codes: set[str]) -> list:
  1520. """The new faults that count (see ``_hms_fault_counts``).
  1521. These go to the MQTT relay; the caller also needs a description before it
  1522. sends a notification. Level 0, Bambu's "invalid" level, never counts. This
  1523. used to read ``severity >= 2`` when severity held the part byte; on the real
  1524. level that would drop the task-stopping errors (#2728).
  1525. """
  1526. return [e for e in errors if _hms_notify_key(e) in new_error_codes and _hms_fault_counts(e)]
  1527. def _take_new_hms_faults(printer_id: int, errors: list, print_state: str | None = None) -> list:
  1528. """The faults on this printer not notified yet, and record them as notified.
  1529. Tracking is updated before anything is sent, so concurrent status callbacks
  1530. cannot notify the same fault twice. A notified fault is forgotten once it
  1531. has been gone for ``_HMS_CLEAR_GRACE_SECONDS``, so one that flickers off
  1532. and on is notified once (#3226), while one that clears and comes back much
  1533. later is notified again.
  1534. When ``print_state`` changes (a print resumed, started or finished), every
  1535. fault recorded so far is forgotten the first time it is gone, without the
  1536. wait: a runout fixed before resuming must be notified if it happens again a
  1537. few minutes later, while the printer sits paused. Not only the faults gone
  1538. at the change itself, because the update that flips the state can still
  1539. carry the old fault (a ``print_error`` entry stays until a payload brings
  1540. ``hms``).
  1541. """
  1542. now = time.time()
  1543. current = {_hms_notify_key(e) for e in errors}
  1544. seen = _notified_hms_errors.setdefault(printer_id, {})
  1545. forget_when_gone = _hms_forget_when_gone.setdefault(printer_id, set())
  1546. if print_state is not None:
  1547. print_state = print_state.upper()
  1548. if _hms_print_state.get(printer_id, print_state) != print_state:
  1549. forget_when_gone.update(seen)
  1550. _hms_print_state[printer_id] = print_state
  1551. for key, last_seen in list(seen.items()):
  1552. if key not in current and (key in forget_when_gone or now - last_seen >= _HMS_CLEAR_GRACE_SECONDS):
  1553. del seen[key]
  1554. forget_when_gone.discard(key)
  1555. new = current - seen.keys()
  1556. for key in current:
  1557. seen[key] = now
  1558. if not seen:
  1559. _notified_hms_errors.pop(printer_id, None)
  1560. if not forget_when_gone:
  1561. _hms_forget_when_gone.pop(printer_id, None)
  1562. return _hms_errors_to_notify(errors, new)
  1563. # `stg_cur` values that mean the printer is not in a preparation stage: 0 is
  1564. # "Printing", -1 and 255 are "no stage" (#3211).
  1565. _NO_PREPARATION_STAGES = frozenset({0, -1, 255})
  1566. def _progress_milestone_to_notify(printer_id: int, state: PrinterState) -> int | None:
  1567. """The milestone (25, 50 or 75) this status update reaches for the first time, if any.
  1568. Records it as notified. Called only for a printing state with progress above 0.
  1569. Progress before the first layer is not progress through the print (#3211).
  1570. An A1 mini reports ``mc_percent`` 85 in the first frame of a print, while
  1571. still preheating the bed at layer 0, then 3, 7, 40 and 44 through its
  1572. calibration, and starts layer 1 at 45. Read as progress, that 85 sent the
  1573. 75% notification together with Print Started, and since 75 was then on
  1574. record, 25 and 50 could never fire. So nothing counts while the printer
  1575. reports a layer count but has not started layer 1.
  1576. Without a layer count -- a print whose first frame carried no
  1577. ``total_layer_num``, until the pushall that asks for it is answered
  1578. (#2702) -- the preparation stage says the same thing: before layer 1 the
  1579. A1 mini reported ``stg_cur`` 2, 4, 14 and 1 (bed preheating, calibration,
  1580. homing), and 0 from layer 1 on. -1 and 255 are "no stage". A printer that
  1581. reports neither keeps the old behaviour rather than never notifying.
  1582. """
  1583. if (state.layer_num or 0) < 1:
  1584. if (state.total_layers or 0) > 0:
  1585. return None
  1586. if state.stg_cur not in _NO_PREPARATION_STAGES:
  1587. return None
  1588. progress = state.progress or 0
  1589. current_milestone = 0
  1590. if progress >= 75:
  1591. current_milestone = 75
  1592. elif progress >= 50:
  1593. current_milestone = 50
  1594. elif progress >= 25:
  1595. current_milestone = 25
  1596. if current_milestone > _last_progress_milestone.get(printer_id, 0):
  1597. _last_progress_milestone[printer_id] = current_milestone
  1598. return current_milestone
  1599. return None
  1600. async def on_printer_status_change(printer_id: int, state: PrinterState):
  1601. """Handle printer status changes - broadcast via WebSocket."""
  1602. try:
  1603. notify_live_activities.observe(printer_id, state)
  1604. except Exception:
  1605. logging.getLogger(__name__).exception("Notify Live Activity status hook failed for printer %s", printer_id)
  1606. # Connected-edge reconciliation (#1542 follow-up). When the printer
  1607. # transitions disconnected → connected — which covers both Bambuddy
  1608. # startup (no prior connection) and a mid-session MQTT reconnect — fire
  1609. # `reconcile_stale_active_prints` exactly once for this connection so
  1610. # any archive still in `status="printing"` that can't actually be
  1611. # running anymore (printer IDLE / different subtask / empty subtask)
  1612. # gets a synthesised PRINT COMPLETE. Without this, a print that
  1613. # finished during a disconnect window + a smart-plug power cycle
  1614. # leaves the .3mf on the SD card and the firmware ghost-replays it on
  1615. # next boot. Reconciliation runs concurrently — it must not block the
  1616. # WebSocket dedup / broadcast logic below, and the connected edge is
  1617. # marked True BEFORE the await so concurrent status updates inside
  1618. # the same connection don't re-trigger reconciliation.
  1619. #
  1620. # Wait for a real push_status before reconciling (#1679): MQTT
  1621. # `_on_connect` broadcasts `state` IMMEDIATELY after the broker accepts
  1622. # the connection, BEFORE `_request_push_all` round-trips. At that
  1623. # instant the `PrinterState` is still on construction defaults — most
  1624. # importantly `state.state == "unknown"` and `state.subtask_name == ""`.
  1625. # If reconcile spawns here, every in-flight archive falls through to
  1626. # the empty-subtask_name trigger and gets synthesised `aborted`, which
  1627. # creates a duplicate archive on the real PRINT COMPLETE and
  1628. # double-counts filament. Gating on `state.state ∉ ("", "unknown")`
  1629. # keeps the #1542 mechanism intact: once the first real push_status
  1630. # updates `state.state` (RUNNING / IDLE / FINISH / …), this handler
  1631. # fires again with the flag still False — reconcile then runs against
  1632. # actual evidence.
  1633. state_known = bool(state.state) and state.state.upper() not in ("", "UNKNOWN")
  1634. if state.connected and state_known and not _printer_reconciled_since_connect.get(printer_id, False):
  1635. _printer_reconciled_since_connect[printer_id] = True
  1636. spawn_background_task(
  1637. reconcile_stale_active_prints(printer_id),
  1638. name=f"reconcile-stale-prints-{printer_id}",
  1639. )
  1640. elif not state.connected and _printer_reconciled_since_connect.get(printer_id, False):
  1641. # Re-arm so the next reconnect triggers reconciliation again.
  1642. _printer_reconciled_since_connect[printer_id] = False
  1643. # Same edge, for the calibration table the AMS card reads its K values from.
  1644. #
  1645. # Also gated on knowing a nozzle diameter, which is what decides *which*
  1646. # tables to ask for. A `state_known` gate alone is not enough: the first
  1647. # real push_status is what makes the state known, and the nozzle fields do
  1648. # not always arrive in it. Latching there would spend this connection's one
  1649. # attempt on a printer that could not yet say what was fitted.
  1650. nozzle_known = any(n.nozzle_diameter for n in (state.nozzles or []))
  1651. if (
  1652. state.connected
  1653. and state_known
  1654. and nozzle_known
  1655. and not _printer_kprofiles_primed_since_connect.get(printer_id, False)
  1656. ):
  1657. _printer_kprofiles_primed_since_connect[printer_id] = True
  1658. spawn_background_task(
  1659. prime_kprofile_table(printer_id),
  1660. name=f"prime-kprofiles-{printer_id}",
  1661. )
  1662. elif not state.connected and _printer_kprofiles_primed_since_connect.get(printer_id, False):
  1663. _printer_kprofiles_primed_since_connect[printer_id] = False
  1664. # A slot can lose its K-profile selection (cali_idx back to -1) with nothing
  1665. # else in the AMS report changing -- a power cycle does it to every slot --
  1666. # and on_ams_change never hears of it (#3219). Checked here, on every push
  1667. # while the printer is idle; needs_check is cheap and throttled per slot.
  1668. # Guarded: nothing here may stop the status broadcast below.
  1669. try:
  1670. if not state.connected:
  1671. kprofile_drift.forget_printer(printer_id)
  1672. elif kprofile_drift.needs_check(printer_id, state):
  1673. spawn_background_task(
  1674. kprofile_drift.reapply_lost_kprofiles(printer_id),
  1675. name=f"reapply-kprofiles-{printer_id}",
  1676. )
  1677. except Exception:
  1678. logging.getLogger(__name__).exception("[Printer %s] K-profile check failed", printer_id)
  1679. # Offline-notification edge (#1752): schedule `on_printer_offline` on
  1680. # connected → disconnected. The "back online" channel is already covered
  1681. # by the print-failure notification (firmware reports gcode_state=FAILED
  1682. # on reconnect of an interrupted print), so there is no online
  1683. # notification. The MQTT relay gets both: offline after the debounce, and
  1684. # online on the reconnect that follows a published offline.
  1685. prev_connected = _printer_last_connected.get(printer_id)
  1686. _printer_last_connected[printer_id] = state.connected
  1687. if prev_connected is True and not state.connected:
  1688. existing = _printer_offline_notify_tasks.get(printer_id)
  1689. if existing is None or existing.done():
  1690. logging.getLogger(__name__).info(
  1691. "[#1752] Printer %s connected→disconnected edge; scheduling offline notification in %.0fs",
  1692. printer_id,
  1693. _PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS,
  1694. )
  1695. _printer_offline_notify_tasks[printer_id] = asyncio.create_task(
  1696. _maybe_notify_printer_offline(printer_id),
  1697. name=f"printer-offline-notify-{printer_id}",
  1698. )
  1699. elif state.connected:
  1700. # Kept until the relay can actually send online: with its broker down
  1701. # now, the next status update after the reconnect sends it.
  1702. if printer_id in _printer_offline_published and mqtt_relay.enabled and mqtt_relay.connected:
  1703. _printer_offline_published.discard(printer_id)
  1704. printer_info = printer_manager.get_printer(printer_id)
  1705. if printer_info:
  1706. try:
  1707. await mqtt_relay.on_printer_online(printer_id, printer_info.name, printer_info.serial_number)
  1708. except Exception as e:
  1709. logging.getLogger(__name__).warning(
  1710. "MQTT relay online event failed for printer %s: %s", printer_id, e
  1711. )
  1712. pending = _printer_offline_notify_tasks.pop(printer_id, None)
  1713. if pending is not None and not pending.done():
  1714. logging.getLogger(__name__).info(
  1715. "[#1752] Printer %s reconnected before debounce; cancelling pending offline notification",
  1716. printer_id,
  1717. )
  1718. pending.cancel()
  1719. # Only broadcast if something meaningful changed (reduce WebSocket spam)
  1720. # Include rounded temperatures to detect meaningful temp changes (within 1 degree)
  1721. temps = state.temperatures or {}
  1722. nozzle_temp = round(temps.get("nozzle", 0))
  1723. bed_temp = round(temps.get("bed", 0))
  1724. nozzle_2_temp = round(temps.get("nozzle_2", 0)) if "nozzle_2" in temps else ""
  1725. chamber_temp = round(temps.get("chamber", 0)) if "chamber" in temps else ""
  1726. # Auto-detect dual-nozzle printers from MQTT temperature data
  1727. if "nozzle_2" in temps and printer_id not in _nozzle_count_updated:
  1728. _nozzle_count_updated.add(printer_id)
  1729. # Update nozzle_count in database
  1730. async with async_session() as db:
  1731. from backend.app.models.printer import Printer
  1732. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1733. printer = result.scalar_one_or_none()
  1734. if printer and printer.nozzle_count != 2:
  1735. printer.nozzle_count = 2
  1736. await db.commit()
  1737. logging.getLogger(__name__).info(
  1738. f"Auto-detected dual-nozzle printer {printer_id}, updated nozzle_count=2"
  1739. )
  1740. # Include target temps for heating phase detection
  1741. bed_target = round(temps.get("bed_target", 0))
  1742. nozzle_target = round(temps.get("nozzle_target", 0))
  1743. # Include tray_now and vt_tray hash so external spool changes trigger broadcasts
  1744. vt_tray_key = hash(str(state.raw_data.get("vt_tray", []))) if state.raw_data else 0
  1745. # Include AMS dry_time and tray state values so drying/slot changes trigger broadcasts.
  1746. #
  1747. # dry_countdown_stalled rides along because it is the one drying signal the
  1748. # countdown itself cannot carry: the MQTT layer raises it precisely BECAUSE
  1749. # dry_time stopped moving, so on the frame that flips it every other member
  1750. # of this key is identical and the push would be deduplicated away. Mid-print
  1751. # a temperature would eventually break the tie, but a parked command on an
  1752. # idle machine changes nothing else at all — AMS temp and humidity are not in
  1753. # the key — so the badge could sit unreachable indefinitely. The flag flips at
  1754. # most once per drying cycle, so it costs no mid-print broadcast traffic.
  1755. ams_dry_key = (
  1756. tuple((a.get("dry_time", 0), bool(a.get("dry_countdown_stalled"))) for a in (state.raw_data.get("ams") or []))
  1757. if state.raw_data
  1758. else ()
  1759. )
  1760. # Include tray states so load/unload transitions (state 11→10) trigger broadcasts (#784)
  1761. #
  1762. # The filament identity fields are here because Configure Slot writes
  1763. # exactly those and nothing else. Re-configuring a slot from PLA to another
  1764. # brand or colour of PLA leaves id/tray_type/state identical, so the key
  1765. # matched, this function returned before broadcasting, and the card kept
  1766. # showing the old filament until the 30s fallback poll or a page reload —
  1767. # even though the configure route asks the printer for a fresh pushall and
  1768. # that push does carry the new values. Reset always worked, because it
  1769. # clears tray_type.
  1770. #
  1771. # These fields only change when someone configures a slot or swaps a spool,
  1772. # so unlike temperature or progress they add no broadcast traffic mid-print.
  1773. ams_tray_key = (
  1774. tuple(
  1775. (
  1776. t.get("id"),
  1777. t.get("tray_type", ""),
  1778. t.get("state"),
  1779. t.get("tray_color", ""),
  1780. t.get("tray_info_idx", ""),
  1781. t.get("tray_sub_brands", ""),
  1782. t.get("cali_idx"),
  1783. )
  1784. for a in (state.raw_data.get("ams") or [])
  1785. for t in a.get("tray", [])
  1786. )
  1787. if state.raw_data
  1788. else ()
  1789. )
  1790. # Filament Track Switch: which inlet each AMS is bound to, and whether the
  1791. # accessory is fitted at all. Neither is in ams_tray_key (it is per-tray) nor
  1792. # in the AMS change-hash (tray fields only, and widening that would fire
  1793. # spurious Spoolman syncs), so without them a "Join IN-B" on the printer
  1794. # screen changed no key at all and the card's inlet badges sat stale until a
  1795. # reload. Like the filament-backup flag, these only move when someone
  1796. # reconfigures the machine, so they add no mid-print broadcast traffic.
  1797. fts_key = (
  1798. state.fila_switch.installed if state.fila_switch else False,
  1799. tuple(sorted(state.ams_switch_inlet.items())),
  1800. # Which hotend holds which slot. Unlike the two above this does move
  1801. # mid-print, on every filament change — but only between discrete slots,
  1802. # so it adds a push per toolchange, not a stream. The AMS slot menu needs
  1803. # it live: it decides which hotend the Load dialog may offer and whether
  1804. # Unload has anything to act on.
  1805. tuple(
  1806. sorted(
  1807. ((ext, slot.ams_id, slot.slot_id, slot.has_filament) for ext, slot in state.extruder_slots.items()),
  1808. # Sort on the extruder id alone: the other members are nullable
  1809. # and comparing None with an int raises.
  1810. key=lambda entry: entry[0],
  1811. )
  1812. ),
  1813. )
  1814. status_key = (
  1815. f"{state.connected}:{state.state}:{state.progress}:{state.layer_num}:"
  1816. f"{nozzle_temp}:{bed_temp}:{nozzle_2_temp}:{chamber_temp}:"
  1817. f"{state.stg_cur}:{bed_target}:{nozzle_target}:"
  1818. f"{state.cooling_fan_speed}:{state.big_fan1_speed}:{state.big_fan2_speed}:"
  1819. f"{state.chamber_light}:{state.active_extruder}:{state.tray_now}:{vt_tray_key}:"
  1820. f"{ams_dry_key}:{ams_tray_key}:{state.door_open}:{state.ams_filament_backup}:{fts_key}"
  1821. )
  1822. # Fields that change only when the machine does (a nozzle swap, a firmware
  1823. # update, developer mode) or once per print (its AMS mapping): no traffic,
  1824. # but on an idle printer nothing else moves the key when they change.
  1825. machine_key = (
  1826. tuple((n.nozzle_type, n.nozzle_diameter) for n in (state.nozzles or [])),
  1827. state.firmware_version,
  1828. state.developer_mode,
  1829. tuple(state.print_ams_mapping) if isinstance(state.print_ams_mapping, list) else None,
  1830. )
  1831. status_key = f"{status_key}:{machine_key}"
  1832. is_active_print = state.state in _ACTIVE_PRINT_STATES
  1833. if not is_active_print:
  1834. _unauthorized_print_kill_sent.discard(printer_id)
  1835. elif printer_id in _unauthorized_print_kill_sent:
  1836. # stop_print() was already sent for this print; avoid all further
  1837. # ownership and settings work until the printer leaves an active state.
  1838. pass
  1839. elif _is_bambuddy_authorized_print_in_memory(printer_id, state):
  1840. # Normal Bambuddy-started prints stay entirely on the in-memory path.
  1841. _unauthorized_print_kill_sent.discard(printer_id)
  1842. else:
  1843. kill_switch_enabled = False
  1844. authorization: bool | None = None
  1845. status_logger = logging.getLogger(__name__)
  1846. try:
  1847. kill_switch_enabled = await _is_printer_kill_switch_enabled_cached()
  1848. if kill_switch_enabled:
  1849. async with async_session() as db:
  1850. authorization = await _is_bambuddy_authorized_print(printer_id, state, db)
  1851. except Exception as e:
  1852. # Fail safe: a database/reconciliation error must never turn into an
  1853. # irreversible stop of a print whose ownership is still unknown.
  1854. authorization = None
  1855. status_logger.warning(
  1856. "[KILL SWITCH] Failed to reconcile print authorization for printer %s: %s", printer_id, e
  1857. )
  1858. if not kill_switch_enabled or authorization is True:
  1859. _unauthorized_print_kill_sent.discard(printer_id)
  1860. elif authorization is None:
  1861. _unauthorized_print_kill_sent.discard(printer_id)
  1862. status_logger.debug(
  1863. "[KILL SWITCH] Deferring authorization for printer %s until archive state is reconciled",
  1864. printer_id,
  1865. )
  1866. else:
  1867. try:
  1868. stopped = printer_manager.stop_print(printer_id)
  1869. if stopped:
  1870. _unauthorized_print_kill_sent.add(printer_id)
  1871. _kill_switch_stopped.add(printer_id)
  1872. printer_info = printer_manager.get_printer(printer_id)
  1873. printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
  1874. filename = state.subtask_name or state.gcode_file or state.current_print or "Unknown"
  1875. notification_data = {
  1876. "status": "stopped",
  1877. "filename": state.gcode_file or state.current_print or "",
  1878. "subtask_name": state.subtask_name or "",
  1879. "progress": state.progress,
  1880. "reason": "unauthorized_print",
  1881. }
  1882. status_logger.warning(
  1883. "[KILL SWITCH] Stopped unauthorized print on printer %s (state=%s)",
  1884. printer_id,
  1885. state.state,
  1886. )
  1887. try:
  1888. await ws_manager.broadcast(
  1889. {
  1890. "type": "kill_switch_triggered",
  1891. "printer_id": printer_id,
  1892. "printer_name": printer_name,
  1893. "filename": filename,
  1894. "reason": "unauthorized_print",
  1895. }
  1896. )
  1897. except Exception as e:
  1898. status_logger.warning(
  1899. "[KILL SWITCH] WebSocket notification failed for printer %s: %s", printer_id, e
  1900. )
  1901. previous_task = _kill_switch_notification_tasks.pop(printer_id, None)
  1902. if previous_task is not None and not previous_task.done():
  1903. previous_task.cancel()
  1904. _kill_switch_notification_tasks[printer_id] = spawn_background_task(
  1905. _send_kill_switch_provider_notification(printer_id, printer_name, notification_data),
  1906. name=f"kill-switch-notification-{printer_id}",
  1907. )
  1908. else:
  1909. status_logger.warning(
  1910. "[KILL SWITCH] Could not stop unauthorized print on printer %s (state=%s)",
  1911. printer_id,
  1912. state.state,
  1913. )
  1914. except Exception as e:
  1915. status_logger.warning(
  1916. "[KILL SWITCH] Failed to stop unauthorized print on printer %s: %s", printer_id, e
  1917. )
  1918. # MQTT relay - publish status (before dedup check - always publish to MQTT)
  1919. try:
  1920. printer_info = printer_manager.get_printer(printer_id)
  1921. if printer_info:
  1922. await mqtt_relay.on_printer_status(
  1923. printer_id,
  1924. state,
  1925. printer_info.name,
  1926. printer_info.serial_number,
  1927. printer_manager.is_awaiting_plate_clear(printer_id),
  1928. )
  1929. except Exception:
  1930. pass # Don't fail status callback if MQTT fails
  1931. if _last_status_broadcast.get(printer_id) == status_key:
  1932. return # No change, skip WebSocket broadcast
  1933. _last_status_broadcast[printer_id] = status_key
  1934. # Check for progress milestone notifications (25%, 50%, 75%)
  1935. progress = state.progress or 0
  1936. is_printing = state.state in ("RUNNING", "PRINTING")
  1937. if is_printing and progress > 0:
  1938. current_milestone = _progress_milestone_to_notify(printer_id, state)
  1939. if current_milestone is not None:
  1940. try:
  1941. from backend.app.models.printer import Printer
  1942. # Read the printer in a short session and release the connection
  1943. # BEFORE the ~15s camera snapshot below — holding it across the grab
  1944. # pinned a pooled connection per milestone, per printer (issue #2572).
  1945. async with async_session() as db:
  1946. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1947. printer = result.scalar_one_or_none()
  1948. printer_name = printer.name if printer else f"Printer {printer_id}"
  1949. filename = state.subtask_name or state.gcode_file or "Unknown"
  1950. # remaining_time is in minutes, convert to seconds for notification
  1951. remaining_time_seconds = state.remaining_time * 60 if state.remaining_time else None
  1952. # Capture camera snapshot for notification image attachment (no DB held).
  1953. image_data = await _capture_snapshot_for_notification(printer_id, printer, logging.getLogger(__name__))
  1954. # Notification send needs a session (provider/template lookups).
  1955. async with async_session() as db:
  1956. await notification_service.on_print_progress(
  1957. printer_id,
  1958. printer_name,
  1959. filename,
  1960. current_milestone,
  1961. db,
  1962. remaining_time_seconds,
  1963. image_data=image_data,
  1964. )
  1965. except Exception as e:
  1966. logging.getLogger(__name__).warning(f"Progress milestone notification failed: {e}")
  1967. elif progress < 5:
  1968. # Reset milestone tracking when print restarts or new print begins
  1969. _last_progress_milestone[printer_id] = 0
  1970. _first_layer_notified[printer_id] = False
  1971. # HMS error codes that should not trigger notifications even though they
  1972. # have known descriptions (e.g. user-initiated actions, not real errors).
  1973. _HMS_NOTIFICATION_SUPPRESS = {
  1974. "0500_400E", # Printing was cancelled (user action, not an error)
  1975. }
  1976. # Check for new HMS errors and send notifications
  1977. current_hms_errors = getattr(state, "hms_errors", []) or []
  1978. if current_hms_errors:
  1979. new_errors = _take_new_hms_faults(printer_id, current_hms_errors, state.state)
  1980. if new_errors:
  1981. try:
  1982. from backend.app.models.printer import Printer
  1983. # Read the printer in a short session and release the connection
  1984. # BEFORE the ~15s camera snapshot below (issue #2572).
  1985. async with async_session() as db:
  1986. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1987. printer = result.scalar_one_or_none()
  1988. printer_name = printer.name if printer else f"Printer {printer_id}"
  1989. # Format error details for notification
  1990. # Module 0x07 = AMS/Filament, 0x05 = Nozzle, 0x0C = Motion Controller, etc.
  1991. module_names = {
  1992. 0x03: "Print/Task",
  1993. 0x05: "Nozzle/Extruder",
  1994. 0x07: "AMS/Filament",
  1995. 0x0C: "Motion Controller",
  1996. 0x12: "Chamber",
  1997. }
  1998. # Capture camera snapshot once for all error notifications (no DB held).
  1999. error_image_data = await _capture_snapshot_for_notification(
  2000. printer_id, printer, logging.getLogger(__name__)
  2001. )
  2002. # Notification sends need a session (provider/template lookups).
  2003. async with async_session() as db:
  2004. sent_count = 0
  2005. for error in new_errors:
  2006. module_name = module_names.get(error.module, f"Module 0x{error.module:02X}")
  2007. # Build short code like "0700_8010"
  2008. # Mask to 16 bits to handle printers that send larger values
  2009. error_code_int = int(error.code.replace("0x", ""), 16) if error.code else 0
  2010. error_code_masked = error_code_int & 0xFFFF
  2011. short_code = f"{(error.attr >> 16) & 0xFFFF:04X}_{error_code_masked:04X}"
  2012. # Only notify for errors Bambu publishes text for — printers
  2013. # send undocumented codes that aren't real errors, and Bambu
  2014. # lists some with empty text. Resolved at parse time (#2926);
  2015. # short_code is still needed for the suppression set below.
  2016. description = error.description
  2017. if not description or short_code in _HMS_NOTIFICATION_SUPPRESS:
  2018. continue
  2019. error_type = f"{module_name} Error"
  2020. error_detail = description
  2021. await notification_service.on_printer_error(
  2022. printer_id, printer_name, error_type, db, error_detail, image_data=error_image_data
  2023. )
  2024. sent_count += 1
  2025. if sent_count:
  2026. logging.getLogger(__name__).info(
  2027. f"[HMS] Sent notification for {sent_count} error(s) on printer {printer_id}"
  2028. )
  2029. # Also publish to MQTT relay (no DB): every new fault that
  2030. # counts, with or without text, the same set the UI counts.
  2031. printer_info = printer_manager.get_printer(printer_id)
  2032. if printer_info:
  2033. errors_data = [
  2034. {
  2035. "code": e.code,
  2036. "attr": e.attr,
  2037. "module": e.module,
  2038. "severity": e.severity,
  2039. }
  2040. for e in new_errors
  2041. ]
  2042. await mqtt_relay.on_printer_error(
  2043. printer_id, printer_info.name, printer_info.serial_number, errors_data
  2044. )
  2045. except Exception as e:
  2046. logging.getLogger(__name__).warning(f"HMS error notification failed: {e}")
  2047. else:
  2048. # No HMS errors: nothing to send, but faults gone long enough (or gone
  2049. # across a print state change) are forgotten. Some codes, e.g. chamber
  2050. # temperature regulation during PETG prints, toggle every few seconds.
  2051. _take_new_hms_faults(printer_id, [], state.state)
  2052. await ws_manager.send_printer_status(
  2053. printer_id,
  2054. printer_state_to_dict(
  2055. state,
  2056. printer_id,
  2057. printer_manager.get_model(printer_id),
  2058. printer_manager.get_drying_targets(printer_id),
  2059. ),
  2060. )
  2061. def _is_bambu_uuid(tray_uuid: str) -> bool:
  2062. """Check if a tray UUID looks like a valid Bambu Lab RFID UUID (non-empty, non-zero)."""
  2063. return bool(tray_uuid) and tray_uuid not in ("", "0" * len(tray_uuid))
  2064. async def on_fts_inlet_change(printer_id: int, ams_id: int, inlet: str):
  2065. """Re-point a moved AMS's K-profiles at the nozzle it now feeds.
  2066. K-profiles are per-nozzle and the printer's calibration table is numbered
  2067. per-nozzle, but a tray holds exactly one ``cali_idx``. Moving an AMS to the
  2068. switch's other inlet therefore silently invalidates every configured slot in
  2069. it: the index stays put and now resolves against the other nozzle's table.
  2070. Measured on the maintainer's H2C — one spool calibrated 0.018 on the left
  2071. and 0.020 on the right kept the left profile after the move, and a manual
  2072. RFID re-read only re-asserted the same wrong one.
  2073. Configuring a slot is a deliberate preparation step, so this re-selects
  2074. rather than re-configures: only the calibration binding moves, and only for
  2075. slots whose spool already has a stored profile for the new nozzle. A slot
  2076. Bambuddy knows nothing about is left exactly as the operator left it.
  2077. """
  2078. logger = logging.getLogger(__name__)
  2079. target_extruder = extruder_for_inlet(inlet)
  2080. if target_extruder is None:
  2081. return
  2082. client = printer_manager.get_client(printer_id)
  2083. state = printer_manager.get_status(printer_id)
  2084. if not client or not state or not state.raw_data:
  2085. return
  2086. # The nozzle the AMS now feeds -- the diameter of the TARGET extruder, not
  2087. # of nozzle 0. On a machine with two sizes fitted, moving the inlet changes
  2088. # the nozzle width, which changes both the K profile to select and the
  2089. # preset the slot should carry.
  2090. nozzle_diameter = nozzle_diameter_for_extruder(state, target_extruder, printer_manager.get_model(printer_id))
  2091. ams_raw = state.raw_data.get("ams")
  2092. ams_list = ams_raw.get("ams", []) if isinstance(ams_raw, dict) else ams_raw if isinstance(ams_raw, list) else []
  2093. unit = next((u for u in ams_list if str(u.get("id")) == str(ams_id)), None)
  2094. if not unit:
  2095. return
  2096. try:
  2097. async with async_session() as db:
  2098. for tray in unit.get("tray", []):
  2099. tray_id = int(tray.get("id", -1))
  2100. if tray_id < 0 or not tray.get("tray_type"):
  2101. continue
  2102. current_idx = tray.get("cali_idx")
  2103. profile = await find_slot_kprofile_for_extruder(
  2104. db,
  2105. printer_id,
  2106. ams_id,
  2107. tray_id,
  2108. target_extruder,
  2109. nozzle_diameter,
  2110. printer_manager.get_model(printer_id),
  2111. nozzle_flow_for_extruder(state, target_extruder, printer_manager.get_model(printer_id)),
  2112. )
  2113. if profile is None or profile.cali_idx is None:
  2114. continue
  2115. if current_idx == profile.cali_idx:
  2116. continue # Already on the right one.
  2117. logger.info(
  2118. "[Printer %s] AMS %s slot %s moved to inlet %s (nozzle %s): "
  2119. "re-selecting K-profile %s (cali_idx %s -> %s, K=%s)",
  2120. printer_id,
  2121. ams_id,
  2122. tray_id,
  2123. inlet,
  2124. target_extruder,
  2125. profile.name,
  2126. current_idx,
  2127. profile.cali_idx,
  2128. profile.k_value,
  2129. )
  2130. client.extrusion_cali_sel(
  2131. ams_id=ams_id,
  2132. tray_id=tray_id,
  2133. cali_idx=profile.cali_idx,
  2134. filament_id=printer_safe_filament_id(profile.filament_id, tray.get("tray_info_idx", "")),
  2135. nozzle_diameter=nozzle_diameter,
  2136. )
  2137. except Exception as e:
  2138. logger.warning("[Printer %s] Could not re-apply K-profiles after inlet move: %s", printer_id, e)
  2139. async def _unlink_stale_assignments(printer_id: int, ams_data: list, printing_now: bool) -> None:
  2140. """Unlink built-in inventory assignments whose slot no longer holds their spool.
  2141. Runs from ``on_ams_change`` and, for removals held by ``slot_unlink_grace``,
  2142. from the delayed re-check -- which is why it takes the AMS data and print
  2143. state as arguments instead of reading them from the push (#3186).
  2144. """
  2145. logger = logging.getLogger(__name__)
  2146. from backend.app.utils.color_utils import colors_similar as _colors_similar
  2147. # Auto-unlink spool assignments with stale fingerprints. Under the
  2148. # per-printer assignment lock since #3186: the held-removal re-check runs
  2149. # this outside any MQTT push, so it can now overlap one.
  2150. try:
  2151. async with _get_ams_assignment_lock(printer_id), async_session() as db:
  2152. from sqlalchemy.orm import selectinload
  2153. from backend.app.api.routes.inventory import _find_tray_in_ams_data
  2154. from backend.app.models.spool import Spool as _Spool
  2155. from backend.app.models.spool_assignment import SpoolAssignment as SA
  2156. from backend.app.services.ams_slot_presence import spool_present
  2157. from backend.app.services.inventory_mode import spoolman_owns_assignments
  2158. # Built-in assignments only. Since #2812 they survive a switch to
  2159. # Spoolman mode rather than being deleted by it, and this pass ends
  2160. # in ``db.delete`` — left ungated it would unlink them one slot at a
  2161. # time as the AMS contents changed under the other mode, undoing the
  2162. # preservation more slowly but just as completely.
  2163. assignments = []
  2164. if not await spoolman_owns_assignments(db):
  2165. result = await db.execute(
  2166. select(SA)
  2167. .where(SA.printer_id == printer_id)
  2168. .options(selectinload(SA.spool).selectinload(_Spool.k_profiles))
  2169. )
  2170. assignments = result.scalars().all()
  2171. # ``printing_now`` (top of this function) keeps a runout from
  2172. # unlinking the spool that fed the print — the next idle-time pass
  2173. # unlinks it if the user really did take it out.
  2174. stale = []
  2175. # Removals this pass is holding rather than unlinking (#3186).
  2176. held: set[tuple] = set()
  2177. for assignment in assignments:
  2178. # External spool assignments (ams_id=255) live in vt_tray, not AMS data
  2179. if assignment.ams_id == 255:
  2180. ps = printer_manager.get_status(printer_id)
  2181. vt_tray_raw = ps.raw_data.get("vt_tray", []) if ps else []
  2182. ext_id = assignment.tray_id + 254 # 0→254, 1→255
  2183. current_tray = None
  2184. for vt in vt_tray_raw:
  2185. if isinstance(vt, dict) and int(vt.get("id", 254)) == ext_id:
  2186. current_tray = vt
  2187. break
  2188. if not current_tray:
  2189. # vt_tray data may not have arrived yet — keep assignment
  2190. continue
  2191. else:
  2192. current_tray = _find_tray_in_ams_data(ams_data, assignment.ams_id, assignment.tray_id)
  2193. if not current_tray:
  2194. if printing_now:
  2195. logger.info(
  2196. "Auto-unlink skipped: spool %d AMS%d-T%d — slot empty during a running print (runout?)",
  2197. assignment.spool_id,
  2198. assignment.ams_id,
  2199. assignment.tray_id,
  2200. )
  2201. continue
  2202. # A whole AMS unit can drop out of one push and come back in
  2203. # the next; only a slot that stays gone is a removal (#3186).
  2204. hold_key = ("inventory", assignment.ams_id, assignment.tray_id, assignment.spool_id)
  2205. if not slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2206. held.add(hold_key)
  2207. logger.info(
  2208. "Auto-unlink held: spool %d AMS%d-T%d — tray not found in AMS data; "
  2209. "unlinking if it is still gone in %ds",
  2210. assignment.spool_id,
  2211. assignment.ams_id,
  2212. assignment.tray_id,
  2213. int(slot_unlink_grace.GRACE_SECONDS),
  2214. )
  2215. continue
  2216. logger.info(
  2217. "Auto-unlink: spool %d AMS%d-T%d — tray not found in AMS data (slot empty?)",
  2218. assignment.spool_id,
  2219. assignment.ams_id,
  2220. assignment.tray_id,
  2221. )
  2222. stale.append(assignment) # Slot empty
  2223. elif _is_bambu_uuid(current_tray.get("tray_uuid", "")):
  2224. # A Bambu Lab spool is in this slot — check if it's the same spool
  2225. # that's currently assigned. If yes, keep the assignment (avoids
  2226. # unnecessary unlink/re-assign/ams_filament_setting cycle that clears
  2227. # the printer's filament preset on every startup).
  2228. tray_uuid = current_tray.get("tray_uuid", "")
  2229. tag_uid = current_tray.get("tag_uid", "")
  2230. spool = assignment.spool
  2231. spool_matches = False
  2232. if spool:
  2233. if (spool.tray_uuid and spool.tray_uuid.upper() == tray_uuid.upper()) or (
  2234. spool.tag_uid
  2235. and tag_uid
  2236. and tag_uid != "0000000000000000"
  2237. and spool.tag_uid.upper() == tag_uid.upper()
  2238. ):
  2239. spool_matches = True
  2240. if spool_matches:
  2241. # Same BL spool still in slot — keep assignment, update fingerprint if needed
  2242. cur_color = current_tray.get("tray_color", "")
  2243. cur_type = current_tray.get("tray_type", "")
  2244. fp_color = assignment.fingerprint_color or ""
  2245. fp_type = assignment.fingerprint_type or ""
  2246. if cur_color.upper() != fp_color.upper() or cur_type.upper() != fp_type.upper():
  2247. assignment.fingerprint_color = cur_color
  2248. assignment.fingerprint_type = cur_type
  2249. logger.debug(
  2250. "Auto-unlink: spool %d AMS%d-T%d — same BL spool, updated fingerprint",
  2251. assignment.spool_id,
  2252. assignment.ams_id,
  2253. assignment.tray_id,
  2254. )
  2255. continue
  2256. # Different BL spool or unrecognized — unlink so auto-assign can match
  2257. logger.info(
  2258. "Auto-unlink: spool %d AMS%d-T%d — different Bambu Lab spool detected (uuid=%s)",
  2259. assignment.spool_id,
  2260. assignment.ams_id,
  2261. assignment.tray_id,
  2262. tray_uuid,
  2263. )
  2264. stale.append(assignment)
  2265. else:
  2266. cur_color = current_tray.get("tray_color", "")
  2267. cur_type = current_tray.get("tray_type", "")
  2268. cur_state = current_tray.get("state")
  2269. fp_color = assignment.fingerprint_color or ""
  2270. fp_type = assignment.fingerprint_type or ""
  2271. # SpoolBuddy pre-config replay: fingerprint_type empty means
  2272. # the slot was empty when the user pre-assigned via SpoolBuddy
  2273. # (the firmware drops ams_filament_setting on empty slots, so
  2274. # MQTT was deferred). The moment any filament gets inserted
  2275. # — Bambu RFID, 3rd-party, or even an existing-but-now-
  2276. # reconfigured spool — fire the deferred configuration.
  2277. # The "loaded" signal is state == 11 (Bambu's "filament fed to
  2278. # extruder" code) OR, on firmwares that don't use the state
  2279. # enum meaningfully, a non-empty tray_type when state is
  2280. # NOT one of the firmware's explicit empty signals (9, 10).
  2281. # state-only was wrong for firmwares that never set 11 — A1
  2282. # Mini BMCU 01.07.02.00 and P1S Standard AMS 00.00.06.75 both
  2283. # always report state=3 — so the replay never fired for them
  2284. # (#1322). The state ∉ {9,10} guard keeps the firmware's
  2285. # explicit "empty" signals authoritative over any stale
  2286. # tray_type that might survive the relay's auto-clearing.
  2287. #
  2288. # tray_exist_bits comes first because that guard cannot tell
  2289. # a firmware "empty" from Bambuddy's own: apply_tray_exist_bits
  2290. # writes state=9 when the bit is 0 and leaves it there when the
  2291. # bit returns. A non-RFID spool inserted into a pre-assigned
  2292. # slot brings no tray_type with it, so the stale 9 made this
  2293. # expression false forever and the deferred config never fired
  2294. # — the deadlock #1322 removed from the assign path, still in
  2295. # place here (#3084, #3100).
  2296. loaded = spool_present(current_tray) is True or (
  2297. cur_state == 11 or (cur_state not in (9, 10) and cur_type.strip())
  2298. )
  2299. if not fp_type.strip() and loaded and assignment.spool:
  2300. try:
  2301. from backend.app.api.routes.inventory import (
  2302. apply_spool_to_slot_via_mqtt,
  2303. )
  2304. await apply_spool_to_slot_via_mqtt(
  2305. db=db,
  2306. current_user=None,
  2307. spool=assignment.spool,
  2308. printer_id=printer_id,
  2309. ams_id=assignment.ams_id,
  2310. tray_id=assignment.tray_id,
  2311. current_tray_info_idx=current_tray.get("tray_info_idx", ""),
  2312. current_tray_type=cur_type,
  2313. current_tray_sub_brands=current_tray.get("tray_sub_brands", ""),
  2314. )
  2315. logger.info(
  2316. "SpoolBuddy pre-config applied on insert: spool %d → printer %d AMS%d-T%d",
  2317. assignment.spool_id,
  2318. printer_id,
  2319. assignment.ams_id,
  2320. assignment.tray_id,
  2321. )
  2322. except Exception:
  2323. logger.exception(
  2324. "Pre-config apply failed for spool %d on printer %d AMS%d-T%d",
  2325. assignment.spool_id,
  2326. printer_id,
  2327. assignment.ams_id,
  2328. assignment.tray_id,
  2329. )
  2330. assignment.fingerprint_color = cur_color
  2331. assignment.fingerprint_type = cur_type
  2332. continue
  2333. if not _colors_similar(cur_color, fp_color) or cur_type.upper() != fp_type.upper():
  2334. # Blank tray data mid-print is a runout, not a swap: the
  2335. # firmware clears colour and type when it unloads a spool
  2336. # it just emptied. Unlinking here would erase the record
  2337. # of which spool fed the print so far.
  2338. if printing_now and not cur_color.strip() and not cur_type.strip():
  2339. logger.info(
  2340. "Auto-unlink skipped: spool %d AMS%d-T%d — tray data cleared during a running print "
  2341. "(runout?)",
  2342. assignment.spool_id,
  2343. assignment.ams_id,
  2344. assignment.tray_id,
  2345. )
  2346. continue
  2347. # Same reasoning off the print, on firmware's own say-so:
  2348. # a blank tray report from a slot whose tray_exist_bits
  2349. # bit is set describes a spool the AMS cannot identify —
  2350. # a non-RFID one, or one whose slot was reset — not a
  2351. # spool that was taken out. Deleting the assignment there
  2352. # threw away the identity the user had supplied, which is
  2353. # the only place it existed (#3100). A slot the bit calls
  2354. # empty, or one that carries no bit at all, still unlinks.
  2355. #
  2356. # Unless the slot was reported empty first: a removal
  2357. # already held means a spool came out and another went
  2358. # in, so the blank report keeps the hold running below
  2359. # rather than cancelling it (#3186).
  2360. if (
  2361. spool_present(current_tray) is True
  2362. and not cur_color.strip()
  2363. and not cur_type.strip()
  2364. and not slot_unlink_grace.is_held(
  2365. printer_id,
  2366. ("inventory", assignment.ams_id, assignment.tray_id, assignment.spool_id),
  2367. )
  2368. ):
  2369. logger.info(
  2370. "Auto-unlink skipped: spool %d AMS%d-T%d — slot still occupied, "
  2371. "tray reports no filament data yet",
  2372. assignment.spool_id,
  2373. assignment.ams_id,
  2374. assignment.tray_id,
  2375. )
  2376. continue
  2377. # A blank report the presence bit does not vouch for is
  2378. # still only one push. An idle X1C cleared a whole AMS
  2379. # unit's bits, colour and type for a moment and lost
  2380. # four saved assignments that way (#3186); unlink only
  2381. # if the slot is still blank after the grace period.
  2382. if not cur_color.strip() and not cur_type.strip():
  2383. hold_key = ("inventory", assignment.ams_id, assignment.tray_id, assignment.spool_id)
  2384. if not slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2385. held.add(hold_key)
  2386. logger.info(
  2387. "Auto-unlink held: spool %d AMS%d-T%d — tray reports no filament data; "
  2388. "unlinking if it is still blank in %ds",
  2389. assignment.spool_id,
  2390. assignment.ams_id,
  2391. assignment.tray_id,
  2392. int(slot_unlink_grace.GRACE_SECONDS),
  2393. )
  2394. continue
  2395. # Fingerprint mismatch — but check if tray now matches the
  2396. # assigned spool (e.g. auto-configure changed the tray).
  2397. # Both sides are reduced to the type the slot can carry
  2398. # before comparing: the assign path writes that rather
  2399. # than the spool's raw material (#2902), so a spool whose
  2400. # material is a product line — "PLA+", "HTPLA" — reports
  2401. # back as "PLA" and would otherwise fail this check and
  2402. # be auto-unlinked from the slot it was just assigned to.
  2403. # Reducing the printer's side too keeps slots configured
  2404. # by an older Bambuddy, still reporting "PLA+", matching.
  2405. spool = assignment.spool
  2406. if spool:
  2407. spool_color = (spool.rgba or "FFFFFFFF").upper()
  2408. # Two ways the assign path can have arrived at the
  2409. # slot's type, so both count as "we wrote this".
  2410. # The material column is one; the spool's preset is
  2411. # the other, and it outranks the material when the
  2412. # spool has one -- a spool whose material says PLA
  2413. # and whose preset is "Bambu PLA Aero" puts
  2414. # PLA-AERO in the slot (#2902). Read from the stored
  2415. # preset name rather than resolving the preset,
  2416. # because this runs on every AMS push and a cloud
  2417. # lookup here would be both slow and unavailable on
  2418. # the unauthenticated replay path.
  2419. spool_types = {printer_filament_type(spool.material).upper()}
  2420. if spool.slicer_filament_name:
  2421. spool_types.add(printer_filament_type(spool.slicer_filament_name).upper())
  2422. # An imported local preset stores its type outright,
  2423. # which is what the assign path used -- and the name
  2424. # above may be unset. One keyed read, and only on a
  2425. # mismatch, which is rare.
  2426. #
  2427. # slicer_filament is free text up to fifty characters,
  2428. # so the digits have to be checked against the range
  2429. # of the integer primary key they are about to be
  2430. # compared with. Postgres raises on an out-of-range
  2431. # integer rather than simply not matching, and that
  2432. # would poison this session and abandon the rest of
  2433. # the cleanup pass.
  2434. lp_ref = (spool.slicer_filament or "").strip()
  2435. if lp_ref.isdigit() and int(lp_ref) <= 2147483647:
  2436. from backend.app.models.local_preset import LocalPreset as _LP
  2437. lp_type = await db.scalar(select(_LP.filament_type).where(_LP.id == int(lp_ref)))
  2438. if lp_type:
  2439. spool_types.add(printer_filament_type(lp_type).upper())
  2440. if (
  2441. _colors_similar(cur_color, spool_color)
  2442. and printer_filament_type(cur_type).upper() in spool_types
  2443. ):
  2444. logger.info(
  2445. "Auto-unlink: spool %d AMS%d-T%d — fingerprint mismatch but tray matches spool, updating fp",
  2446. assignment.spool_id,
  2447. assignment.ams_id,
  2448. assignment.tray_id,
  2449. )
  2450. assignment.fingerprint_color = cur_color
  2451. assignment.fingerprint_type = cur_type
  2452. continue
  2453. logger.info(
  2454. "Auto-unlink: spool %d AMS%d-T%d — fingerprint mismatch (cur=%s/%s fp=%s/%s spool=%s/%s)",
  2455. assignment.spool_id,
  2456. assignment.ams_id,
  2457. assignment.tray_id,
  2458. cur_color,
  2459. cur_type,
  2460. fp_color,
  2461. fp_type,
  2462. spool.rgba if spool else "?",
  2463. spool.material if spool else "?",
  2464. )
  2465. stale.append(assignment) # Spool changed
  2466. slot_unlink_grace.settle(printer_id, "inventory", held)
  2467. # Snapshot slots before delete — ORM attribute access after the
  2468. # commit would refresh against a deleted row.
  2469. unlinked_slots = [(a.ams_id, a.tray_id) for a in stale]
  2470. for a in stale:
  2471. await db.delete(a)
  2472. if stale:
  2473. logger.info("Auto-unlinked %d stale spool assignments for printer %d", len(stale), printer_id)
  2474. # Commit any changes (stale deletions and/or fingerprint updates)
  2475. await db.commit()
  2476. # Tell open browsers the assignment is gone (#2575). Only the manual
  2477. # REST assign/unassign endpoints broadcast this event; without it the
  2478. # frontend's spool-assignments cache keeps rendering the unlinked
  2479. # spool on the slot until an unrelated refetch — which reads exactly
  2480. # like "the fix didn't work" (reporter verified: a browser refresh
  2481. # after the swap showed the correct state all along).
  2482. for ams_id, tray_id in unlinked_slots:
  2483. await ws_manager.broadcast(
  2484. {
  2485. "type": "spool_assignment_changed",
  2486. "printer_id": printer_id,
  2487. "ams_id": ams_id,
  2488. "tray_id": tray_id,
  2489. }
  2490. )
  2491. except Exception as e:
  2492. logger.warning("Spool assignment cleanup failed: %s", e, exc_info=True)
  2493. async def _expire_spoolman_empty_slots(printer_id: int, ams_data: list, printing_now: bool) -> None:
  2494. """Delete Spoolman slot rows whose held removal has run its grace period.
  2495. The Spoolman half of the #3186 re-check. The full sync in ``on_ams_change``
  2496. talks to Spoolman for every tray; this only needs the local rows, so it
  2497. repeats that pass's empty-slot decision -- a tray with no type or no colour
  2498. (``parse_ams_tray`` returns None for exactly those), not during a print, and
  2499. not in a slot the presence bit calls occupied -- and nothing else.
  2500. """
  2501. logger = logging.getLogger(__name__)
  2502. try:
  2503. async with async_session() as db:
  2504. from backend.app.api.routes.settings import get_setting
  2505. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2506. from backend.app.services.ams_slot_presence import spool_present
  2507. enabled = await get_setting(db, "spoolman_enabled")
  2508. if not enabled or enabled.lower() != "true":
  2509. return
  2510. sync_mode = await get_setting(db, "spoolman_sync_mode")
  2511. if sync_mode and sync_mode != "auto":
  2512. return
  2513. trays: dict[tuple[int, int], dict] = {}
  2514. for ams_unit in ams_data or []:
  2515. if not isinstance(ams_unit, dict):
  2516. continue
  2517. for tray in ams_unit.get("tray", []):
  2518. if isinstance(tray, dict):
  2519. trays[(int(ams_unit.get("id", 0)), int(tray.get("id", 0)))] = tray
  2520. rows = (
  2521. (
  2522. await db.execute(
  2523. select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer_id)
  2524. )
  2525. )
  2526. .scalars()
  2527. .all()
  2528. )
  2529. held: set[tuple] = set()
  2530. expired: list[tuple[int, int]] = []
  2531. for row in rows:
  2532. tray = trays.get((row.ams_id, row.tray_id))
  2533. if tray is None or printing_now:
  2534. continue
  2535. if (tray.get("tray_type") or "").strip() and (tray.get("tray_color") or "").strip():
  2536. continue
  2537. hold_key = ("spoolman", row.ams_id, row.tray_id, row.spoolman_spool_id)
  2538. if spool_present(tray) is True and not slot_unlink_grace.is_held(printer_id, hold_key):
  2539. continue
  2540. if slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2541. expired.append((row.ams_id, row.tray_id))
  2542. else:
  2543. held.add(hold_key)
  2544. slot_unlink_grace.settle(printer_id, "spoolman", held)
  2545. if not expired:
  2546. return
  2547. # A statement rather than ORM deletes, like the sync pass: the two
  2548. # can overlap, and a row the other already removed must not fail
  2549. # this commit.
  2550. for ams_id, tray_id in expired:
  2551. await db.execute(
  2552. delete(SpoolmanSlotAssignment).where(
  2553. SpoolmanSlotAssignment.printer_id == printer_id,
  2554. SpoolmanSlotAssignment.ams_id == ams_id,
  2555. SpoolmanSlotAssignment.tray_id == tray_id,
  2556. )
  2557. )
  2558. await db.commit()
  2559. logger.info("Unlinked %d Spoolman slot(s) that stayed empty for printer %d", len(expired), printer_id)
  2560. for ams_id, tray_id in expired:
  2561. await ws_manager.broadcast(
  2562. {
  2563. "type": "spool_assignment_changed",
  2564. "printer_id": printer_id,
  2565. "ams_id": ams_id,
  2566. "tray_id": tray_id,
  2567. }
  2568. )
  2569. except Exception as e:
  2570. logger.warning("Spoolman slot re-check failed for printer %s: %s", printer_id, e, exc_info=True)
  2571. async def _recheck_held_unlinks(printer_id: int) -> None:
  2572. """Re-run just the slot cleanup against the printer's current AMS state.
  2573. Scheduled by ``slot_unlink_grace`` when it holds a removal. The unlink
  2574. passes otherwise run only when the AMS hash changes, and a slot that went
  2575. empty and stayed empty may never change it again.
  2576. """
  2577. status = printer_manager.get_status(printer_id)
  2578. # A disconnected printer's state is its last report, not a new one: acting
  2579. # on it would "confirm" a removal nobody has seen for the whole grace
  2580. # period. Leave the holds; the first push after reconnecting decides.
  2581. if status is None or not status.connected:
  2582. return
  2583. ams_raw = status.raw_data.get("ams")
  2584. ams_data = ams_raw.get("ams", []) if isinstance(ams_raw, dict) else ams_raw if isinstance(ams_raw, list) else []
  2585. printing_now = (getattr(status, "state", "") or "").upper() in ("RUNNING", "PAUSE")
  2586. await _unlink_stale_assignments(printer_id, ams_data, printing_now)
  2587. await _expire_spoolman_empty_slots(printer_id, ams_data, printing_now)
  2588. slot_unlink_grace.set_recheck(_recheck_held_unlinks)
  2589. async def on_ams_change(printer_id: int, ams_data: list):
  2590. """Handle AMS data changes - sync to Spoolman if enabled and auto mode."""
  2591. logger = logging.getLogger(__name__)
  2592. # Snapshot BEFORE any await: if a print is active, skip weight sync later.
  2593. # on_print_complete may pop _active_sessions during our awaits (#880).
  2594. from backend.app.services.usage_tracker import _active_sessions
  2595. _print_active = printer_id in _active_sessions
  2596. # A slot that reports empty while a print is running is a filament runout,
  2597. # not a spool swap: the spool is still physically in the AMS, just
  2598. # consumed. Dropping either inventory backend's slot link there loses the
  2599. # only record of which spool fed the print, so the completion path can't
  2600. # charge the runout segment to anything. Both cleanup passes below consult
  2601. # this; computed once, up front, so neither depends on the other having run.
  2602. _unlink_state = printer_manager.get_status(printer_id)
  2603. printing_now = (getattr(_unlink_state, "state", "") or "").upper() in ("RUNNING", "PAUSE")
  2604. # The session alone is not enough: a restart that finds a stale persisted
  2605. # session registers none for the print that is running.
  2606. _print_active = _print_active or printing_now
  2607. # MQTT relay - publish AMS change
  2608. try:
  2609. printer_info = printer_manager.get_printer(printer_id)
  2610. if printer_info:
  2611. await mqtt_relay.on_ams_change(printer_id, printer_info.name, printer_info.serial_number, ams_data)
  2612. except Exception:
  2613. pass # Don't fail AMS callback if MQTT fails
  2614. # Broadcast AMS change via WebSocket (bypasses status_key deduplication)
  2615. # This ensures frontend gets immediate updates when AMS slots are configured
  2616. try:
  2617. state = printer_manager.get_status(printer_id)
  2618. if state:
  2619. logger.info("[Printer %s] Broadcasting AMS change via WebSocket", printer_id)
  2620. await ws_manager.send_printer_status(
  2621. printer_id,
  2622. printer_state_to_dict(
  2623. state,
  2624. printer_id,
  2625. printer_manager.get_model(printer_id),
  2626. printer_manager.get_drying_targets(printer_id),
  2627. ),
  2628. )
  2629. except Exception as e:
  2630. logger.warning("Failed to broadcast AMS change for printer %s: %s", printer_id, e)
  2631. await _unlink_stale_assignments(printer_id, ams_data, printing_now)
  2632. # Auto-manage inventory spools from AMS tray data (skip if Spoolman manages AMS).
  2633. # Serialised per-printer via _ams_assignment_locks: MQTT bursts can deliver
  2634. # two AMS pushes ~30 ms apart, and without the lock both callbacks read
  2635. # "no existing assignment" for the same (printer, ams, tray) and race to
  2636. # INSERT, hitting the spool_assignment_printer_id_ams_id_tray_id_key
  2637. # unique constraint on Postgres. SQLite's WAL serialises writes so the
  2638. # bug stayed latent there. See _ams_assignment_locks comment for details.
  2639. try:
  2640. async with _get_ams_assignment_lock(printer_id), async_session() as db:
  2641. from sqlalchemy.orm import selectinload
  2642. from backend.app.api.routes.settings import get_setting
  2643. from backend.app.models.spool import Spool
  2644. from backend.app.models.spool_assignment import SpoolAssignment as SA
  2645. from backend.app.services.spool_tag_matcher import (
  2646. auto_assign_spool,
  2647. create_spool_from_tray,
  2648. find_matching_untagged_spool,
  2649. get_spool_by_tag,
  2650. is_bambu_tag,
  2651. is_valid_tag,
  2652. link_tag_to_inventory_spool,
  2653. tag_belongs_to_archived_spool,
  2654. )
  2655. _spoolman_on = await get_setting(db, "spoolman_enabled")
  2656. _auto_add_raw = await get_setting(db, "auto_add_unknown_rfid")
  2657. _auto_add_unknown = _auto_add_raw is None or _auto_add_raw.lower() == "true"
  2658. if not _spoolman_on or _spoolman_on.lower() != "true":
  2659. for ams_unit in ams_data:
  2660. if not isinstance(ams_unit, dict):
  2661. continue
  2662. ams_id = int(ams_unit.get("id", 0))
  2663. for tray in ams_unit.get("tray", []):
  2664. if not isinstance(tray, dict):
  2665. continue
  2666. tray_id = int(tray.get("id", 0))
  2667. tag_uid = tray.get("tag_uid", "")
  2668. tray_uuid = tray.get("tray_uuid", "")
  2669. tray_info_idx = tray.get("tray_info_idx", "")
  2670. if not tray.get("tray_type"):
  2671. # Slot reported empty — drop any cached unknown-tag
  2672. # broadcast so reinserting the same spool re-prompts.
  2673. _clear_unknown_tag_dedup(printer_id, ams_id, tray_id)
  2674. continue # Empty slot
  2675. # Check if assignment already exists for this slot
  2676. existing = await db.execute(
  2677. select(SA)
  2678. .options(selectinload(SA.spool).selectinload(Spool.k_profiles))
  2679. .where(SA.printer_id == printer_id, SA.ams_id == ams_id, SA.tray_id == tray_id)
  2680. )
  2681. existing_assignment = existing.scalar_one_or_none()
  2682. if existing_assignment:
  2683. # Sync spool weight_used from AMS remain — only INCREASE, never decrease.
  2684. # The AMS remain% is low-resolution (integer %, i.e. 10g steps for 1kg spool)
  2685. # and must not overwrite precise values from the usage tracker (3MF/G-code).
  2686. # Skip during active prints: the usage tracker handles deduction
  2687. # precisely via 3MF data on print completion. Without this guard the
  2688. # AMS remain% SET and the usage tracker ADD both fire from the same
  2689. # MQTT message, doubling the deduction (#880).
  2690. if _print_active:
  2691. continue
  2692. remain_raw = tray.get("remain")
  2693. if (
  2694. remain_raw is not None
  2695. and existing_assignment.spool
  2696. and not existing_assignment.spool.weight_locked
  2697. ):
  2698. try:
  2699. remain_val = int(remain_raw)
  2700. except (TypeError, ValueError):
  2701. remain_val = -1
  2702. if 1 <= remain_val <= 100:
  2703. lw = existing_assignment.spool.label_weight or 1000
  2704. new_used = round(lw * (100 - remain_val) / 100.0, 1)
  2705. current_used = existing_assignment.spool.weight_used or 0
  2706. if new_used > current_used + 1:
  2707. logger.info(
  2708. "Weight sync: spool %d weight_used %s -> %s (remain=%d)",
  2709. existing_assignment.spool_id,
  2710. current_used,
  2711. new_used,
  2712. remain_val,
  2713. )
  2714. existing_assignment.spool.weight_used = new_used
  2715. await db.commit()
  2716. # A K-profile the slot lost (the default K after a reset or
  2717. # power cycle) is put back by kprofile_drift on the next idle
  2718. # push; a different real profile was picked on purpose and
  2719. # stays (#3219, item 44).
  2720. continue
  2721. if is_bambu_tag(tag_uid, tray_uuid, tray_info_idx):
  2722. # BL spool with RFID tag: auto-match → inventory match → auto-create
  2723. spool = await get_spool_by_tag(db, tag_uid, tray_uuid)
  2724. if not spool and await tag_belongs_to_archived_spool(db, tag_uid, tray_uuid):
  2725. # An archived spool still in the AMS: the slot
  2726. # stays free rather than adopting its tag.
  2727. continue
  2728. if not spool:
  2729. # Try matching an untagged inventory spool (same material/color)
  2730. spool = await find_matching_untagged_spool(db, tray)
  2731. if spool:
  2732. await link_tag_to_inventory_spool(db, spool, tray)
  2733. elif _auto_add_unknown:
  2734. spool = await create_spool_from_tray(db, tray)
  2735. else:
  2736. # Auto-add disabled: surface the slot so the
  2737. # user can add it manually via the UI.
  2738. await _broadcast_unknown_tag(
  2739. printer_id=printer_id,
  2740. ams_id=ams_id,
  2741. tray_id=tray_id,
  2742. tag_uid=tag_uid,
  2743. tray_uuid=tray_uuid,
  2744. tray_type=tray.get("tray_type"),
  2745. tray_color=tray.get("tray_color"),
  2746. tray_sub_brands=tray.get("tray_sub_brands"),
  2747. tray_count=len(ams_unit.get("tray", [])),
  2748. )
  2749. continue
  2750. # Slot matched (existing tag, untagged inventory
  2751. # match, or freshly auto-created spool) — drop any
  2752. # stale dedup so a future tag swap re-prompts.
  2753. _clear_unknown_tag_dedup(printer_id, ams_id, tray_id)
  2754. await auto_assign_spool(
  2755. printer_id,
  2756. ams_id,
  2757. tray_id,
  2758. spool,
  2759. printer_manager,
  2760. db,
  2761. tray_info_idx=tray_info_idx,
  2762. )
  2763. await db.commit()
  2764. await ws_manager.broadcast(
  2765. {
  2766. "type": "spool_auto_assigned",
  2767. "printer_id": printer_id,
  2768. "ams_id": ams_id,
  2769. "tray_id": tray_id,
  2770. "spool_id": spool.id,
  2771. }
  2772. )
  2773. logger.info(
  2774. "RFID auto-assigned spool %d to printer %d AMS%d-T%d",
  2775. spool.id,
  2776. printer_id,
  2777. ams_id,
  2778. tray_id,
  2779. )
  2780. elif is_valid_tag(tag_uid, tray_uuid) and not await tag_belongs_to_archived_spool(
  2781. db, tag_uid, tray_uuid
  2782. ):
  2783. # Non-BL spool with some tag — let user choose (not
  2784. # an archived one's, whose slot stays free)
  2785. await _broadcast_unknown_tag(
  2786. printer_id=printer_id,
  2787. ams_id=ams_id,
  2788. tray_id=tray_id,
  2789. tag_uid=tag_uid,
  2790. tray_uuid=tray_uuid,
  2791. tray_type=tray.get("tray_type"),
  2792. tray_color=tray.get("tray_color"),
  2793. tray_sub_brands=tray.get("tray_sub_brands"),
  2794. tray_count=len(ams_unit.get("tray", [])),
  2795. )
  2796. # No-tag slots (generic non-RFID filament) are left alone:
  2797. # nothing to identify, prompting "+ Add" would just create
  2798. # ghost spools with empty tags on every confirm.
  2799. except Exception as e:
  2800. logger.warning("RFID spool auto-assign failed: %s", e, exc_info=True)
  2801. try:
  2802. async with async_session() as db:
  2803. from backend.app.api.routes.settings import get_setting
  2804. from backend.app.models.printer import Printer
  2805. # Check if Spoolman is enabled
  2806. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  2807. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  2808. return
  2809. # Check sync mode
  2810. sync_mode = await get_setting(db, "spoolman_sync_mode")
  2811. if sync_mode and sync_mode != "auto":
  2812. return # Only sync on auto mode
  2813. _auto_add_raw_sm = await get_setting(db, "auto_add_unknown_rfid")
  2814. auto_add_unknown_rfid = _auto_add_raw_sm is None or _auto_add_raw_sm.lower() == "true"
  2815. # `spoolman_disable_weight_sync` is deprecated (#1119) — weight is now
  2816. # always owned by per-print tracking, never by AMS auto-sync. The
  2817. # setting is still read by the settings UI for backwards compat but
  2818. # has no effect on the sync path here.
  2819. # Get Spoolman URL
  2820. spoolman_url = await get_setting(db, "spoolman_url")
  2821. if not spoolman_url:
  2822. return
  2823. # Get or create Spoolman client
  2824. client = await get_spoolman_client()
  2825. if not client:
  2826. try:
  2827. client = await init_spoolman_client(spoolman_url)
  2828. except ValueError as exc:
  2829. logger.warning("Spoolman URL %r rejected by SSRF guard: %s", spoolman_url, exc)
  2830. return
  2831. # Check if Spoolman is reachable
  2832. if not await client.health_check():
  2833. logger.warning("Spoolman not reachable at %s", spoolman_url)
  2834. return
  2835. # Get printer name for location
  2836. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  2837. printer = result.scalar_one_or_none()
  2838. printer_name = printer.name if printer else f"Printer {printer_id}"
  2839. # OPTIMIZATION: Fetch all spools once before processing trays
  2840. # This eliminates redundant API calls (one per tray) when syncing multiple trays
  2841. logger.debug("[Printer %s] Fetching spools cache for AMS sync...", printer_id)
  2842. try:
  2843. cached_spools = await client.get_spools()
  2844. logger.debug("[Printer %s] Cached %d spools for batch sync", printer_id, len(cached_spools))
  2845. except Exception as e:
  2846. logger.error(
  2847. "[Printer %s] Failed to fetch spools cache after retries, aborting AMS sync: %s",
  2848. printer_id,
  2849. e,
  2850. )
  2851. return
  2852. # Load inventory weights as fallback (when AMS MQTT data lacks remain values)
  2853. from sqlalchemy.orm import selectinload
  2854. from backend.app.models.spool_assignment import SpoolAssignment
  2855. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2856. from backend.app.services.ams_slot_presence import spool_present
  2857. from backend.app.services.inventory_mode import spoolman_owns_assignments
  2858. # Built-in remaining weight, used by sync_ams_tray only when the
  2859. # firmware reports an unusable remain%/tray_weight for a slot.
  2860. #
  2861. # Left empty since #2812. This block runs in Spoolman mode only,
  2862. # and until then the built-in table was emptied on the switch, so
  2863. # there was never anything here to read and the fallback was inert.
  2864. # Preserving those rows makes it live again, and it is keyed by slot
  2865. # rather than by spool: after a mode switch the tray may well hold
  2866. # different filament, and ``create_spool`` writes ``remaining_weight``
  2867. # unconditionally, so a stale figure would be seeded into a brand new
  2868. # Spoolman spool. Deliberately kept inert rather than deleted, so the
  2869. # intent survives for whoever revisits the cross-mode fallback.
  2870. inventory_weights: dict[tuple[int, int], float] = {}
  2871. if not await spoolman_owns_assignments(db):
  2872. try:
  2873. assign_result = await db.execute(
  2874. select(SpoolAssignment)
  2875. .options(selectinload(SpoolAssignment.spool))
  2876. .where(SpoolAssignment.printer_id == printer_id)
  2877. )
  2878. for assignment in assign_result.scalars().all():
  2879. spool = assignment.spool
  2880. if spool and spool.label_weight > 0:
  2881. remaining = max(0.0, spool.label_weight - (spool.weight_used or 0))
  2882. inventory_weights[(assignment.ams_id, assignment.tray_id)] = remaining
  2883. except Exception as e:
  2884. logger.warning("Could not load inventory weights for printer %s: %s", printer_id, e)
  2885. # Load existing Spoolman slot assignments for the no-RFID fallback path
  2886. spoolman_slot_map: dict[tuple[int, int], int] = {}
  2887. try:
  2888. slot_result = await db.execute(
  2889. select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer_id)
  2890. )
  2891. for slot in slot_result.scalars().all():
  2892. spoolman_slot_map[(slot.ams_id, slot.tray_id)] = slot.spoolman_spool_id
  2893. except Exception as e:
  2894. logger.warning("Could not load Spoolman slot assignments for printer %s: %s", printer_id, e)
  2895. # Sync each AMS tray and collect slot changes for DB persistence
  2896. synced = 0
  2897. slot_changes: list[tuple[int, int, int]] = [] # (ams_id, tray_id, spoolman_spool_id) to upsert
  2898. empty_slots: list[tuple[int, int]] = [] # (ams_id, tray_id) whose tray is now empty
  2899. spoolman_held: set[tuple] = set() # removals held for the grace period (#3186)
  2900. for ams_unit in ams_data:
  2901. if not isinstance(ams_unit, dict):
  2902. continue
  2903. ams_id = int(ams_unit.get("id", 0))
  2904. trays = ams_unit.get("tray", [])
  2905. for tray_data in trays:
  2906. if not isinstance(tray_data, dict):
  2907. continue
  2908. tray_id_raw = int(tray_data.get("id", 0))
  2909. tray = client.parse_ams_tray(ams_id, tray_data)
  2910. if not tray:
  2911. # Empty tray slot — record for local assignment cleanup
  2912. # and drop any cached unknown-tag broadcast so a
  2913. # reinserted spool re-prompts.
  2914. #
  2915. # Not during a running print: a slot that empties there
  2916. # is a filament runout, and the spool is still in the
  2917. # AMS. `spoolman_slot_assignments` is how a tag-less
  2918. # spool assigned through the Bambuddy UI is resolved at
  2919. # completion (#1459), so deleting the row mid-print
  2920. # loses the runout segment's usage — the same failure
  2921. # the internal inventory's auto-unlink had.
  2922. #
  2923. # Nor when firmware's presence bit says the slot is
  2924. # occupied. parse_ams_tray calls a tray with no type or
  2925. # no colour empty, and a spool the AMS cannot read has
  2926. # neither until something configures it — so a tag-less
  2927. # spool assigned through the UI had its row deleted by
  2928. # the first idle push after it was inserted. Same
  2929. # deletion as the internal inventory's in #3100, same
  2930. # answer, so the two modes stay in step.
  2931. #
  2932. # And only once the slot has stayed empty for the grace
  2933. # period -- the internal inventory's #3186 answer, for
  2934. # the same one-push blank.
  2935. linked_spool = spoolman_slot_map.get((ams_id, tray_id_raw))
  2936. hold_key = ("spoolman", ams_id, tray_id_raw, linked_spool)
  2937. if not printing_now and (
  2938. spool_present(tray_data) is not True or slot_unlink_grace.is_held(printer_id, hold_key)
  2939. ):
  2940. if linked_spool is None or slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2941. empty_slots.append((ams_id, tray_id_raw))
  2942. else:
  2943. spoolman_held.add(hold_key)
  2944. logger.info(
  2945. "Spoolman slot unlink held: AMS%d-T%d (spool %d) reports empty; "
  2946. "unlinking if it is still empty in %ds",
  2947. ams_id,
  2948. tray_id_raw,
  2949. linked_spool,
  2950. int(slot_unlink_grace.GRACE_SECONDS),
  2951. )
  2952. _clear_unknown_tag_dedup(printer_id, ams_id, tray_id_raw)
  2953. continue
  2954. spool_tag = (
  2955. tray.tray_uuid
  2956. if tray.tray_uuid and tray.tray_uuid != "00000000000000000000000000000000"
  2957. else tray.tag_uid
  2958. )
  2959. # Provide the hint only when no RFID is available
  2960. hint = spoolman_slot_map.get((ams_id, tray.tray_id)) if not spool_tag else None
  2961. try:
  2962. inv_remaining = inventory_weights.get((ams_id, tray.tray_id))
  2963. result = await client.sync_ams_tray(
  2964. tray,
  2965. printer_name,
  2966. db,
  2967. # Per-print tracking is the only weight writer (#1119).
  2968. # AMS auto-sync still maintains spool metadata / slot
  2969. # assignments but no longer touches remaining_weight.
  2970. disable_weight_sync=True,
  2971. cached_spools=cached_spools,
  2972. inventory_remaining=inv_remaining,
  2973. spoolman_spool_id_hint=hint,
  2974. auto_add_unknown_rfid=auto_add_unknown_rfid,
  2975. )
  2976. if result is None and spool_tag and not auto_add_unknown_rfid:
  2977. # Spoolman skipped auto-create per user setting — surface
  2978. # the slot so the UI can offer "+ Add to inventory".
  2979. await _broadcast_unknown_tag(
  2980. printer_id=printer_id,
  2981. ams_id=ams_id,
  2982. tray_id=tray.tray_id,
  2983. tag_uid=tray.tag_uid or "",
  2984. tray_uuid=tray.tray_uuid or "",
  2985. tray_type=tray.tray_type,
  2986. tray_color=tray.tray_color,
  2987. tray_sub_brands=tray.tray_sub_brands,
  2988. tray_count=len(trays),
  2989. )
  2990. elif result:
  2991. _clear_unknown_tag_dedup(printer_id, ams_id, tray.tray_id)
  2992. if result:
  2993. synced += 1
  2994. if result.get("id"):
  2995. slot_changes.append((ams_id, tray.tray_id, result["id"]))
  2996. # If a new spool was created, add it to the cache
  2997. # so subsequent trays can find it if they reference the same tag
  2998. spool_exists = any(s.get("id") == result["id"] for s in cached_spools)
  2999. if not spool_exists:
  3000. cached_spools.append(result)
  3001. logger.debug(
  3002. "[Printer %s] Added newly created spool %s to cache",
  3003. printer_id,
  3004. result["id"],
  3005. )
  3006. # Reconcile slot_preset_mappings (the same row internal
  3007. # mode keeps in sync via inventory + spool_tag_matcher).
  3008. # Without this the slot card surfaces the previous spool's
  3009. # preset name — same bug shape, different inventory mode.
  3010. from backend.app.services.slot_preset_writer import (
  3011. upsert_slot_preset_for_spoolman_spool,
  3012. )
  3013. await upsert_slot_preset_for_spoolman_spool(
  3014. db=db,
  3015. spoolman_spool=result,
  3016. tray_info_idx=tray.tray_info_idx or "",
  3017. tray_sub_brands=tray.tray_sub_brands or "",
  3018. tray_type=tray.tray_type or "",
  3019. printer_id=printer_id,
  3020. ams_id=ams_id,
  3021. tray_id=tray.tray_id,
  3022. )
  3023. except Exception as e:
  3024. logger.error("Error syncing AMS %s tray %s: %s", ams_id, tray.tray_id, e)
  3025. slot_unlink_grace.settle(printer_id, "spoolman", spoolman_held)
  3026. if synced > 0:
  3027. logger.info("Auto-synced %s AMS trays to Spoolman for printer %s", synced, printer_id)
  3028. # Persist slot assignment changes to the local table
  3029. if slot_changes or empty_slots:
  3030. try:
  3031. for ams_id, tray_id, spool_id in slot_changes:
  3032. await db.execute(
  3033. text(
  3034. "INSERT INTO spoolman_slot_assignments"
  3035. " (printer_id, ams_id, tray_id, spoolman_spool_id)"
  3036. " VALUES (:printer_id, :ams_id, :tray_id, :spool_id)"
  3037. " ON CONFLICT(printer_id, ams_id, tray_id)"
  3038. " DO UPDATE SET spoolman_spool_id = excluded.spoolman_spool_id"
  3039. ),
  3040. {
  3041. "printer_id": printer_id,
  3042. "ams_id": ams_id,
  3043. "tray_id": tray_id,
  3044. "spool_id": spool_id,
  3045. },
  3046. )
  3047. for ams_id, tray_id in empty_slots:
  3048. await db.execute(
  3049. delete(SpoolmanSlotAssignment).where(
  3050. SpoolmanSlotAssignment.printer_id == printer_id,
  3051. SpoolmanSlotAssignment.ams_id == ams_id,
  3052. SpoolmanSlotAssignment.tray_id == tray_id,
  3053. )
  3054. )
  3055. await db.commit()
  3056. except Exception as e:
  3057. await db.rollback()
  3058. logger.error("Error persisting Spoolman slot assignments for printer %s: %s", printer_id, e)
  3059. else:
  3060. # Tell open browsers the slot changed. This loop rewrites
  3061. # slot_preset_mappings via upsert_slot_preset_for_spoolman_spool
  3062. # above, and the AMS slot card reads that row ahead of the
  3063. # live tray_info_idx -- so with no event the card keeps
  3064. # showing the previous spool's preset name. Internal mode
  3065. # raises spool_auto_assigned for the same reason; this loop
  3066. # broadcast nothing at all, which made Spoolman mode the
  3067. # worse half of the same bug. On the else branch so a
  3068. # failed commit stays silent and a broadcast failure cannot
  3069. # roll back rows that are already committed.
  3070. for ams_id, tray_id, *_ in (*slot_changes, *empty_slots):
  3071. await ws_manager.broadcast(
  3072. {
  3073. "type": "spool_assignment_changed",
  3074. "printer_id": printer_id,
  3075. "ams_id": ams_id,
  3076. "tray_id": tray_id,
  3077. }
  3078. )
  3079. except Exception as e:
  3080. logging.getLogger(__name__).error("Spoolman AMS sync failed for printer %s: %s", printer_id, e)
  3081. # Largest finish photo attached to a notification; a bigger one is still linked.
  3082. _FINISH_PHOTO_ATTACH_MAX_BYTES = 2_500_000
  3083. async def _finish_photo_for_notification(
  3084. db, archive, archive_id: int, filename: str
  3085. ) -> tuple[str | None, bytes | None]:
  3086. """The ``{finish_photo_url}`` link and the bytes to attach, for a print's finish photo.
  3087. With authentication off the link is the archive's own photo route, as it
  3088. always was: it opens without a login and doesn't expire. With
  3089. authentication on that route needs a media token, which nothing tapping a
  3090. link in Telegram, CallMeBot or a Home Assistant notification has, so the
  3091. link only ever answered 401. The photo is then saved as a notification
  3092. photo as well (utils/notification_photos.py) and the link points there: an
  3093. unguessable name that opens this one photo and nothing else, for 3 days.
  3094. The link is relative when no External URL is set. Bytes over
  3095. ``_FINISH_PHOTO_ATTACH_MAX_BYTES`` are linked but not attached. Returns
  3096. ``(None, None)`` when the photo can't be found.
  3097. """
  3098. from backend.app.api.routes.settings import get_setting
  3099. from backend.app.core.auth import is_auth_enabled
  3100. from backend.app.utils.archive_paths import find_archive_photo
  3101. from backend.app.utils.notification_photos import save_notification_photo
  3102. log = logging.getLogger(__name__)
  3103. base = ((await get_setting(db, "external_url")) or "").strip().rstrip("/")
  3104. url: str | None = f"{base}/api/v1/archives/{archive_id}/photos/{filename}"
  3105. photo_bytes: bytes | None = None
  3106. try:
  3107. photo_path = find_archive_photo(archive, filename)
  3108. if photo_path is not None:
  3109. photo_bytes = await asyncio.to_thread(photo_path.read_bytes)
  3110. except Exception as e:
  3111. log.warning("[NOTIFY-BG] Failed to read finish photo bytes: %s", e)
  3112. try:
  3113. auth_on = await is_auth_enabled(db)
  3114. except Exception:
  3115. auth_on = True # Unknown: the archive link may need a login, so don't rely on it.
  3116. if auth_on:
  3117. url = None
  3118. if photo_bytes:
  3119. try:
  3120. name = await asyncio.to_thread(save_notification_photo, photo_bytes, "print_complete")
  3121. url = f"{base}/api/v1/notifications/photos/{name}"
  3122. except Exception as e:
  3123. log.warning("[NOTIFY-BG] Failed to save finish photo for its link: %s", e)
  3124. if photo_bytes is not None and len(photo_bytes) > _FINISH_PHOTO_ATTACH_MAX_BYTES:
  3125. log.warning("[NOTIFY-BG] Finish photo too large for attachment: %s bytes", len(photo_bytes))
  3126. return url, None
  3127. if photo_bytes:
  3128. log.info("[NOTIFY-BG] Loaded finish photo bytes: %s bytes", len(photo_bytes))
  3129. return url, photo_bytes
  3130. async def _capture_snapshot_for_notification(printer_id: int, printer, logger, *, light: bool = True) -> bytes | None:
  3131. """Capture a camera snapshot for notification image attachment.
  3132. Returns JPEG bytes (max 2.5MB) or None if capture fails or is unavailable.
  3133. Uses: external camera > buffered frame > fresh capture.
  3134. Turns the chamber light on for the picture when the printer asks for it
  3135. (#1655). ``light=False`` is for callers that capture all through a print,
  3136. where the light would flash with every frame.
  3137. """
  3138. if not printer:
  3139. return None
  3140. async with camera_light(printer if light else None):
  3141. return await _capture_snapshot_frame(printer_id, printer, logger)
  3142. async def _capture_snapshot_frame(printer_id: int, printer, logger) -> bytes | None:
  3143. """The capture behind ``_capture_snapshot_for_notification``."""
  3144. try:
  3145. from backend.app.api.routes.settings import get_setting
  3146. async with async_session() as db:
  3147. capture_enabled = await get_setting(db, "capture_finish_photo")
  3148. if capture_enabled is not None and capture_enabled.lower() != "true":
  3149. return None
  3150. # Try external camera first
  3151. if printer.external_camera_enabled and printer.external_camera_url:
  3152. logger.info("[SNAPSHOT] Capturing from external camera for printer %s", printer_id)
  3153. from backend.app.api.routes.camera import live_frame_for_capture
  3154. from backend.app.services.external_camera import capture_frame
  3155. # An external camera allows one reader, so capturing while a viewer
  3156. # is attached fails (#2707). A None here falls through to the paths
  3157. # below exactly as a failed capture did.
  3158. defer, buffered = live_frame_for_capture(printer_id)
  3159. if defer:
  3160. frame_data = buffered
  3161. else:
  3162. frame_data = await capture_frame(
  3163. printer.external_camera_url,
  3164. printer.external_camera_type or "mjpeg",
  3165. snapshot_url=printer.external_camera_snapshot_url,
  3166. )
  3167. if frame_data and len(frame_data) <= 2_500_000:
  3168. logger.info("[SNAPSHOT] External camera frame: %s bytes", len(frame_data))
  3169. return _apply_camera_rotation(frame_data, printer, logger)
  3170. # Try buffered frame from active stream
  3171. from backend.app.api.routes.camera import _active_chamber_streams, _active_streams, get_buffered_frame
  3172. active_for_printer = [k for k in _active_streams if k.startswith(f"{printer_id}-")]
  3173. active_chamber = [k for k in _active_chamber_streams if k.startswith(f"{printer_id}-")]
  3174. buffered_frame = get_buffered_frame(printer_id)
  3175. if (active_for_printer or active_chamber) and buffered_frame:
  3176. logger.info("[SNAPSHOT] Using buffered frame for printer %s: %s bytes", printer_id, len(buffered_frame))
  3177. if len(buffered_frame) <= 2_500_000:
  3178. return _apply_camera_rotation(buffered_frame, printer, logger)
  3179. # Fresh capture from printer camera
  3180. logger.info("[SNAPSHOT] Capturing fresh frame for printer %s", printer_id)
  3181. from backend.app.services.camera import capture_camera_frame_bytes
  3182. frame_data = await capture_camera_frame_bytes(
  3183. printer.ip_address, printer.access_code, printer.model, timeout=15
  3184. )
  3185. if frame_data and len(frame_data) <= 2_500_000:
  3186. logger.info("[SNAPSHOT] Fresh camera frame: %s bytes", len(frame_data))
  3187. return _apply_camera_rotation(frame_data, printer, logger)
  3188. except Exception as e:
  3189. logger.warning("[SNAPSHOT] Failed to capture snapshot for printer %s: %s", printer_id, e)
  3190. return None
  3191. async def _maybe_bank_inprint_frame(printer_id: int, layer_num: int) -> None:
  3192. """#1867: bank a recent in-print camera frame for the finish photo.
  3193. Called on every layer change and (#2547) on every print-progress advance.
  3194. Grabs one frame (throttled) into ``_inprint_frame_bank`` so the finish-photo
  3195. path has a pre-End-G-code image for prints that end with a plate swap.
  3196. Both drivers are print telemetry that stops the instant printing ends: no
  3197. further layers, and progress freezes before the End G-code (e.g. SwapMod
  3198. plate swap) executes. So the last banked frame is always the finished print,
  3199. never the swapped plate — that property is what the #1867 path relies on and
  3200. it must survive any change to the throttle below.
  3201. Layer changes alone were not enough: they stop when the *final* layer
  3202. begins, which on a three-minute last layer left the bank stale by the whole
  3203. length of that layer (#2547). Progress keeps ticking through it.
  3204. Best-effort: any failure just leaves the previous banked frame.
  3205. """
  3206. logger = logging.getLogger(__name__)
  3207. client = printer_manager.get_client(printer_id)
  3208. state = client.state if client else None
  3209. if not state or state.state != "RUNNING":
  3210. return
  3211. # Only during actual extrusion — firmware ticks layer_num during the
  3212. # pre-print calibration sequence, whose sub-stages are non-zero.
  3213. if state.mc_print_sub_stage not in (None, 0):
  3214. return
  3215. # #2547: throttled uniformly, with no last-layer exemption. The old code
  3216. # bypassed the throttle on the final layer to guarantee a fresh frame there;
  3217. # now that progress advances also drive banking, that exemption would fire a
  3218. # camera grab on every percent tick of the last layer. Bambu printers accept
  3219. # one RTSP client at a time, so each grab contends with the live view.
  3220. now = time.monotonic()
  3221. last = _inprint_frame_bank_ts.get(printer_id, 0.0)
  3222. if (now - last) < _INPRINT_BANK_MIN_INTERVAL:
  3223. return
  3224. total = state.total_layers or 0
  3225. try:
  3226. async with async_session() as db:
  3227. from backend.app.models.printer import Printer
  3228. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  3229. printer = result.scalar_one_or_none()
  3230. if not printer:
  3231. return
  3232. # Reuses the notification snapshot path, which honours the
  3233. # `capture_finish_photo` setting (returns None when disabled) so we
  3234. # don't bank frames the user never asked for. Without the chamber light
  3235. # (#1655): this runs every 25 seconds for the whole print.
  3236. frame = await _capture_snapshot_for_notification(printer_id, printer, logger, light=False)
  3237. if frame:
  3238. _inprint_frame_bank[printer_id] = frame
  3239. _inprint_frame_bank_ts[printer_id] = now
  3240. logger.debug(
  3241. "[FINISH-PHOTO-BANK] banked in-print frame for printer %s at layer %s/%s (%d bytes)",
  3242. printer_id,
  3243. layer_num,
  3244. total,
  3245. len(frame),
  3246. )
  3247. except Exception as e:
  3248. logger.debug("[FINISH-PHOTO-BANK] bank failed for printer %s: %s", printer_id, e)
  3249. def _apply_camera_rotation(image_data: bytes, printer, logger) -> bytes:
  3250. """Apply camera rotation to snapshot image if configured."""
  3251. from backend.app.services.camera import apply_camera_rotation
  3252. return apply_camera_rotation(image_data, getattr(printer, "camera_rotation", 0), logger)
  3253. async def _send_print_start_notification(
  3254. printer_id: int,
  3255. data: dict,
  3256. archive_data: dict | None = None,
  3257. logger=None,
  3258. ):
  3259. """Helper to send print start notification with optional archive data."""
  3260. if logger is None:
  3261. logger = logging.getLogger(__name__)
  3262. try:
  3263. async with async_session() as db:
  3264. from backend.app.models.printer import Printer
  3265. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  3266. printer = result.scalar_one_or_none()
  3267. printer_name = printer.name if printer else f"Printer {printer_id}"
  3268. # Capture camera snapshot for notification image attachment
  3269. image_data = await _capture_snapshot_for_notification(printer_id, printer, logger)
  3270. if image_data:
  3271. if archive_data is None:
  3272. archive_data = {}
  3273. archive_data["image_data"] = image_data
  3274. await notification_service.on_print_start(printer_id, printer_name, data, db, archive_data=archive_data)
  3275. # Send user-specific email notification for print start
  3276. if archive_data and archive_data.get("created_by_id"):
  3277. await notification_service.send_user_print_email(
  3278. event_type="user_print_start",
  3279. created_by_id=archive_data["created_by_id"],
  3280. printer_name=printer_name,
  3281. filename=data.get("subtask_name") or data.get("filename", "Unknown"),
  3282. db=db,
  3283. )
  3284. except Exception as e:
  3285. logger.warning("Notification on_print_start failed: %s", e)
  3286. async def _dispatch_user_print_email(
  3287. status: str,
  3288. created_by_id: int | None,
  3289. printer_name: str,
  3290. filename: str,
  3291. db,
  3292. image_data: bytes | None = None,
  3293. finish_photo_url: str | None = None,
  3294. ) -> None:
  3295. """Send a user-specific print-completion email based on print status.
  3296. Maps the normalised print status to the correct event type and delegates
  3297. to :meth:`NotificationService.send_user_print_email`. A single helper
  3298. avoids duplicating the ``if status == "completed" / elif "failed" / elif
  3299. "stopped"`` dispatch block at every call site.
  3300. Does nothing if *created_by_id* is ``None``.
  3301. """
  3302. if created_by_id is None:
  3303. return
  3304. if status == "completed":
  3305. event_type = "user_print_complete"
  3306. elif status == "failed":
  3307. event_type = "user_print_failed"
  3308. elif status in ("stopped", "aborted", "cancelled"):
  3309. event_type = "user_print_stopped"
  3310. else:
  3311. return
  3312. await notification_service.send_user_print_email(
  3313. event_type=event_type,
  3314. created_by_id=created_by_id,
  3315. printer_name=printer_name,
  3316. filename=filename,
  3317. db=db,
  3318. image_data=image_data,
  3319. finish_photo_url=finish_photo_url,
  3320. )
  3321. def _load_objects_from_archive(archive, printer_id: int, logger) -> None:
  3322. """Extract printable objects from an archive's 3MF file and store in printer state."""
  3323. try:
  3324. from backend.app.services.archive import extract_printable_objects_from_archive
  3325. client = printer_manager.get_client(printer_id)
  3326. if not client:
  3327. return
  3328. # Extract with positions for UI overlay, scoped to the plate that
  3329. # is printing — resolve_plate_id is the same resolver /cover uses,
  3330. # so the object list can't disagree with the thumbnail it is drawn
  3331. # over (#2522).
  3332. printable_objects, bbox_all = extract_printable_objects_from_archive(
  3333. app_settings.base_dir / archive.file_path,
  3334. plate_number=resolve_plate_id(client.state),
  3335. )
  3336. if printable_objects:
  3337. client.state.printable_objects = printable_objects
  3338. client.state.printable_objects_bbox_all = bbox_all
  3339. client.state.skipped_objects = []
  3340. logger.info("Loaded %s printable objects for printer %s", len(printable_objects), printer_id)
  3341. except Exception as e:
  3342. logger.debug("Failed to extract printable objects from archive: %s", e)
  3343. async def _restore_printable_objects(printer_id: int, state, db, logger) -> None:
  3344. """Put the skip-objects list back after a restart mid-print.
  3345. ``PrinterState.printable_objects`` is in-memory only, and the only thing
  3346. that fills it is ``_load_objects_from_archive`` on the print-start paths —
  3347. which the #1304 guard suppresses on the first RUNNING push after startup.
  3348. Everything else this hook restores (the archive, the usage-tracking session,
  3349. the timelapse baseline) was already handled; the object list was not, so a
  3350. restart mid-print took skip-objects away for the rest of that print.
  3351. Nothing recovered it either: the printer card gates its Skip button on the
  3352. object count, and the one endpoint that can rebuild the list is reachable
  3353. only from the modal that button opens.
  3354. Anchored on ``subtask_id``, which the firmware mints per print, so a
  3355. leftover ``status="printing"`` row from a completion we never saw cannot
  3356. hand this print someone else's objects. Without one, nothing is loaded
  3357. rather than guessed — the reload path on ``GET /print/objects`` covers that
  3358. case on demand.
  3359. """
  3360. client = printer_manager.get_client(printer_id)
  3361. if client is None or client.state.printable_objects:
  3362. return
  3363. subtask_id = str(getattr(state, "subtask_id", "") or "").strip()
  3364. if subtask_id in ("", "0"):
  3365. return
  3366. from backend.app.models.archive import PrintArchive
  3367. archive = await db.scalar(
  3368. select(PrintArchive)
  3369. .where(
  3370. PrintArchive.printer_id == printer_id,
  3371. PrintArchive.status == "printing",
  3372. PrintArchive.subtask_id == subtask_id,
  3373. )
  3374. .order_by(PrintArchive.created_at.desc())
  3375. .limit(1)
  3376. )
  3377. if archive is not None:
  3378. _load_objects_from_archive(archive, printer_id, logger)
  3379. # Retry ladder for a fallback archive created while the printer's FTPS cool-off
  3380. # was running (#2957). The cool-off is 300s, so the first attempt is placed just
  3381. # past it; the second covers a handshake that failed again on the way back and
  3382. # armed a fresh one. Module-level so tests can shrink them.
  3383. _FALLBACK_3MF_RETRY_DELAYS_SECONDS: tuple[float, ...] = (310.0, 620.0)
  3384. # Retry ladder for the other temporary give-up: the file service answered and
  3385. # the transfer still did not finish, which at print start is usually the printer
  3386. # serving MQTT, the camera and a job upload at the same time (#3063). Nothing has
  3387. # to expire here, so the first attempt comes early -- #3063's reporter had the
  3388. # same 19MB file complete 48 seconds after the download budget ran out. The later
  3389. # two cover a printer that stays busy well into the print.
  3390. _FALLBACK_3MF_TRANSFER_RETRY_DELAYS_SECONDS: tuple[float, ...] = (60.0, 240.0, 600.0)
  3391. # printer_id -> the in-flight retry task, so print completion can cancel it.
  3392. _fallback_3mf_retry_tasks: dict[int, asyncio.Task] = {}
  3393. # printer_id -> lock serialising recovery attempts for that printer. Three callers
  3394. # can reach one archive at once: the cover endpoint (whose single-flight coalesces
  3395. # by view, so two views race), the cool-off retry task, and print completion.
  3396. # Without this they each read file_path == "" and each run a full copy, so the row
  3397. # ends up pointing at one timestamped directory while the others sit orphaned.
  3398. #
  3399. # Keyed by printer rather than archive because a printer runs one print at a time,
  3400. # which makes the two equally strong here — and it bounds the dict by printer
  3401. # count instead of needing a cleanup pass. Popping a per-archive entry cannot be
  3402. # done safely: `Lock.locked()` reads False between release and the queued waiter
  3403. # resuming, so "no waiters" is not a question this API can answer.
  3404. _fallback_recovery_locks: dict[int, asyncio.Lock] = {}
  3405. async def _recover_fallback_archive(archive_id: int, source_3mf: Path, printer_id: int, *, price: bool = True) -> bool:
  3406. """Fill in a no-3MF archive from a 3MF that turned up later.
  3407. Returns True when the row was upgraded. Safe to call speculatively: it
  3408. verifies the archive still exists, is still a fallback, and that the file
  3409. is a readable 3MF before touching anything.
  3410. Serialised per printer — see ``_fallback_recovery_locks``.
  3411. """
  3412. lock = _fallback_recovery_locks.setdefault(printer_id, asyncio.Lock())
  3413. async with lock:
  3414. return await _recover_fallback_archive_locked(archive_id, source_3mf, printer_id, price=price)
  3415. async def _recover_fallback_archive_locked(
  3416. archive_id: int, source_3mf: Path, printer_id: int, *, price: bool = True
  3417. ) -> bool:
  3418. """The body of :func:`_recover_fallback_archive`, under its per-printer lock.
  3419. ``price`` is False when the print's end is being handled: the archive
  3420. still reads "printing" then, and its end prices it.
  3421. """
  3422. import zipfile
  3423. from backend.app.models.archive import PrintArchive
  3424. from backend.app.services.archive import ArchiveService
  3425. logger = logging.getLogger(__name__)
  3426. if not source_3mf.exists() or source_3mf.stat().st_size == 0:
  3427. return False
  3428. if not await asyncio.to_thread(zipfile.is_zipfile, source_3mf):
  3429. # A truncated or half-written download is worse than no download: it
  3430. # would replace an honest empty archive with wrong metadata.
  3431. logger.warning("[RECOVER] %s is not a readable 3MF; leaving archive %s as-is", source_3mf, archive_id)
  3432. return False
  3433. async with async_session() as db:
  3434. archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  3435. if archive is None or archive.deleted_at is not None:
  3436. return False
  3437. if archive.file_path:
  3438. # Already recovered, or never was a fallback. Either way there is a
  3439. # real 3MF attached and overwriting it is not this function's job.
  3440. return False
  3441. print_data = (archive.extra_data or {}).get("_print_data") or {}
  3442. service = ArchiveService(db)
  3443. recovered = await service.archive_print(
  3444. printer_id=printer_id,
  3445. source_file=source_3mf,
  3446. print_data={**print_data, "status": archive.status or "printing"},
  3447. subtask_id=archive.subtask_id,
  3448. update_archive_id=archive.id,
  3449. )
  3450. if recovered is None:
  3451. return False
  3452. logger.info(
  3453. "[RECOVER] Archive %s filled in from %s (%s bytes) — it started as a no-3MF fallback",
  3454. archive_id,
  3455. source_3mf,
  3456. recovered.file_size,
  3457. )
  3458. if price and recovered.status == "printing":
  3459. # Print start priced it from the default rate, having no 3MF to
  3460. # estimate from; now it has one. An ended print is left alone: its
  3461. # end prices it. A print Bambuddy didn't dispatch has no start
  3462. # plate; the one the archive just read from the 3MF stands in.
  3463. _schedule_archive_cost_estimate(
  3464. printer_id,
  3465. recovered.id,
  3466. printer_manager,
  3467. ams_mapping=_get_start_ams_mapping(print_data, recovered.id),
  3468. plate_id=_get_start_plate_id(recovered.id) or recovered.plate_id,
  3469. session_factory=async_session,
  3470. )
  3471. # `archive_updated`, not `archive_created` — the row was already on the
  3472. # Archives page as an empty card and is now filled in, not new.
  3473. await ws_manager.send_archive_updated(
  3474. {
  3475. "id": recovered.id,
  3476. "printer_id": recovered.printer_id,
  3477. "filename": recovered.filename,
  3478. "print_name": recovered.print_name,
  3479. "status": recovered.status,
  3480. }
  3481. )
  3482. return True
  3483. async def try_recover_fallback_archive(printer_id: int, name: str, path: Path, *, price: bool = True) -> bool:
  3484. """Offer a freshly-downloaded 3MF to this printer's running fallback archive.
  3485. Called from the paths that pull a 3MF for a print that is already under way
  3486. — chiefly the cover endpoint, which downloads the very file the archive flow
  3487. could not get and, before #2957, used it for a thumbnail and nothing else.
  3488. The bytes are already local, so this costs a parse and a row update.
  3489. No-op when the running print has a real archive, which is the common case.
  3490. """
  3491. from backend.app.models.archive import PrintArchive
  3492. logger = logging.getLogger(__name__)
  3493. # `_active_prints` is keyed on the raw names seen at print start — the
  3494. # dispatch filename, the subtask name, and the subtask name plus ".3mf".
  3495. # Callers here arrive with whichever variant their own path produced, so
  3496. # match on the same normalization the download cache uses rather than on an
  3497. # exact string; that is what makes "Desktop_Goose.gcode.3mf" from the cover
  3498. # endpoint find an archive registered under "Desktop_Goose".
  3499. wanted = normalize_3mf_name(name)
  3500. archive_id = None
  3501. for (key_printer_id, key_name), value in list(_active_prints.items()):
  3502. if key_printer_id == printer_id and normalize_3mf_name(key_name) == wanted:
  3503. archive_id = value
  3504. break
  3505. if archive_id is None:
  3506. return False
  3507. async with async_session() as db:
  3508. archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  3509. # Cheap pre-check so the common case (a normal archive) does no work.
  3510. if archive is None or archive.file_path or archive.deleted_at is not None:
  3511. return False
  3512. try:
  3513. return await _recover_fallback_archive(archive_id, path, printer_id, price=price)
  3514. except Exception as e:
  3515. # Recovery is opportunistic. A failure here must never take down the
  3516. # caller, which is usually just trying to render a thumbnail.
  3517. logger.warning("[RECOVER] Could not fill in archive %s from %s: %s", archive_id, path, e)
  3518. return False
  3519. def _schedule_fallback_3mf_retry(
  3520. printer_id: int,
  3521. archive_id: int,
  3522. filenames: list[str],
  3523. delays: tuple[float, ...] | None = None,
  3524. reason: str = REASON_FTPS_COOLOFF,
  3525. ) -> None:
  3526. """Re-attempt the 3MF download after a temporary give-up.
  3527. ``reason`` says which give-up this is, and picks the default ladder: an
  3528. FTPS cool-off has to be waited out, while a transfer that timed out under
  3529. contention is worth asking about again straight away (#3063). It is only
  3530. read for the ladder and the log line -- the retry itself is identical, since
  3531. in both cases the file is on the printer and the last attempt at it failed
  3532. for a reason that does not last.
  3533. """
  3534. logger = logging.getLogger(__name__)
  3535. if delays is None:
  3536. delays = (
  3537. _FALLBACK_3MF_TRANSFER_RETRY_DELAYS_SECONDS
  3538. if reason == REASON_FTP_TRANSFER_FAILED
  3539. else _FALLBACK_3MF_RETRY_DELAYS_SECONDS
  3540. )
  3541. async def _retry() -> None:
  3542. from backend.app.models.archive import PrintArchive
  3543. from backend.app.models.printer import Printer
  3544. for delay in delays:
  3545. await asyncio.sleep(delay)
  3546. async with async_session() as db:
  3547. archive = (
  3548. await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  3549. ).scalar_one_or_none()
  3550. if archive is None or archive.deleted_at is not None or archive.file_path:
  3551. return
  3552. printer = (await db.execute(select(Printer).where(Printer.id == printer_id))).scalar_one_or_none()
  3553. if printer is None:
  3554. return
  3555. # Read the fields while the session is open rather than touching
  3556. # a detached instance minutes later, mid-download.
  3557. printer_ip = printer.ip_address
  3558. printer_code = printer.access_code
  3559. printer_model = printer.model
  3560. # Someone else may have fetched it in the meantime — the cover
  3561. # endpoint routinely does, and its copy is the same bytes.
  3562. for name in filenames:
  3563. cached = get_cached_3mf(printer_id, name)
  3564. if cached and await _recover_fallback_archive(archive_id, cached, printer_id):
  3565. return
  3566. if ftps_handshake_blocked(printer_ip):
  3567. logger.info(
  3568. "[RECOVER] Printer %s is still in its FTPS cool-off; archive %s retry deferred",
  3569. printer_id,
  3570. archive_id,
  3571. )
  3572. continue
  3573. _, _, _, ftp_timeout = await get_ftp_retry_settings()
  3574. for candidate in filenames:
  3575. # Bare name only. These come from the print-start flow, which
  3576. # already strips the path, but the local temp write must not
  3577. # depend on that holding for every future caller — a name that
  3578. # is absolute or contains ".." would otherwise escape the data
  3579. # volume via the `/` operator.
  3580. name = Path(candidate).name
  3581. if not name or name in (".", ".."):
  3582. continue
  3583. if not name.endswith(".3mf"):
  3584. name = f"{name}.3mf"
  3585. temp_path = app_settings.archive_dir / "temp" / name
  3586. temp_path.parent.mkdir(parents=True, exist_ok=True)
  3587. try:
  3588. hit = await download_file_try_paths_async(
  3589. printer_ip,
  3590. printer_code,
  3591. ftp_probe_paths(name),
  3592. temp_path,
  3593. socket_timeout=ftp_timeout,
  3594. printer_model=printer_model,
  3595. max_total_timeout=RECOVERY_DOWNLOAD_MAX_TIMEOUT,
  3596. )
  3597. except Exception as e:
  3598. logger.debug("[RECOVER] Retry download of %s failed: %s", name, e)
  3599. continue
  3600. if not hit:
  3601. continue
  3602. cache_3mf_download(printer_id, name, temp_path)
  3603. if await _recover_fallback_archive(archive_id, temp_path, printer_id):
  3604. return
  3605. logger.info("[RECOVER] Archive %s still has no 3MF after a retry", archive_id)
  3606. async def _guarded() -> None:
  3607. try:
  3608. await _retry()
  3609. except asyncio.CancelledError:
  3610. raise
  3611. except Exception as e:
  3612. logger.warning("[RECOVER] Retry task for archive %s failed: %s", archive_id, e)
  3613. finally:
  3614. if _fallback_3mf_retry_tasks.get(printer_id) is asyncio.current_task():
  3615. _fallback_3mf_retry_tasks.pop(printer_id, None)
  3616. existing = _fallback_3mf_retry_tasks.pop(printer_id, None)
  3617. if existing and not existing.done():
  3618. existing.cancel()
  3619. task = asyncio.create_task(_guarded())
  3620. _fallback_3mf_retry_tasks[printer_id] = task
  3621. logger.info(
  3622. "[RECOVER] Archive %s has no 3MF (%s) and the file should still be on printer %s; will retry in %s",
  3623. archive_id,
  3624. reason,
  3625. printer_id,
  3626. ", ".join(f"{d:g}s" for d in delays),
  3627. )
  3628. async def _ask_outcome_for_external_print(db, printer_id: int, observed_name: str | None = None) -> bool:
  3629. """Whether an archive created here should ask for the print's outcome (#1898).
  3630. Only a print Bambuddy did not dispatch reaches the archive-*creating*
  3631. branches below: a queued job already has its archive and takes the
  3632. expected-print branch, where the queue item's own ``confirm_outcome``
  3633. decides. The queue is still consulted, because a restart mid-print empties
  3634. ``_expected_prints`` — without the check the setting could override a queue
  3635. item that deliberately has the flag off. Any failure answers "don't ask":
  3636. an unwanted prompt is worse than a missing one, and this must never be the
  3637. reason a print goes unarchived.
  3638. A ``printing`` row is not proof on its own, though: Bambuddy deliberately
  3639. leaves one behind when a completion cannot be matched to it
  3640. (``_completion_belongs_to_queue_item``), and the scheduler's stranded sweep
  3641. only takes it back once the printer has sat connected and terminal for
  3642. minutes. Until then every screen-started print on that printer would
  3643. silently lose its prompt, so the row is held against ``observed_name`` by
  3644. the same comparison a completion uses: a positive disagreement means the row
  3645. is about some other run and this print is external after all.
  3646. """
  3647. logger = logging.getLogger(__name__)
  3648. try:
  3649. # A savepoint rather than a rollback of the caller's transaction on
  3650. # failure: a failed statement leaves the transaction unusable, but a
  3651. # full rollback also expires every object the caller has loaded (the
  3652. # printer, the archive it just created), and on an async session the
  3653. # next attribute read then raises instead of reloading. Everything here
  3654. # is a read, so undoing the savepoint loses nothing.
  3655. async with db.begin_nested():
  3656. return await _decide_outcome_for_external_print(db, printer_id, observed_name, logger)
  3657. except Exception as e:
  3658. logger.warning("[CALLBACK] Could not decide the outcome prompt for printer %s: %s", printer_id, e)
  3659. return False
  3660. async def _decide_outcome_for_external_print(db, printer_id: int, observed_name: str | None, logger) -> bool:
  3661. """The reads behind ``_ask_outcome_for_external_print``; see there."""
  3662. from backend.app.api.routes.settings import get_setting, setting_is_true
  3663. if not setting_is_true(await get_setting(db, "confirm_outcome_external_prints")):
  3664. return False
  3665. from backend.app.models.print_queue import PrintQueueItem
  3666. dispatched_here = await db.scalar(
  3667. select(PrintQueueItem)
  3668. .where(
  3669. PrintQueueItem.printer_id == printer_id,
  3670. PrintQueueItem.status == "printing",
  3671. )
  3672. .limit(1)
  3673. )
  3674. if dispatched_here is None:
  3675. return True
  3676. expected = await _queue_item_dispatched_name(db, dispatched_here)
  3677. observed = (observed_name or "").strip()
  3678. if not expected or not observed or _subtask_names_match(expected, observed):
  3679. logger.info(
  3680. "[CALLBACK] Not asking for the outcome on printer %s: queue item %s is still printing, so "
  3681. "Bambuddy dispatched this run and the item's own ask-for-outcome flag decides.",
  3682. printer_id,
  3683. dispatched_here.id,
  3684. )
  3685. return False
  3686. logger.info(
  3687. "[CALLBACK] Queue item %s is still marked printing on printer %s but was dispatched as %r, not "
  3688. "%r; treating this as an externally started print.",
  3689. dispatched_here.id,
  3690. printer_id,
  3691. expected,
  3692. observed,
  3693. )
  3694. return True
  3695. async def _dispatch_outcome_confirmation_safely(
  3696. db,
  3697. printer_id: int,
  3698. printer_name: str,
  3699. data: dict,
  3700. archive_id: int,
  3701. archive_data: dict | None = None,
  3702. ) -> None:
  3703. """``dispatch_outcome_confirmation`` for a caller that has more to do on ``db``.
  3704. The completion task sends the per-user print email on the same session
  3705. right after the prompt. A failed statement in the prompt leaves that
  3706. session needing a rollback, and without one the email step fails with
  3707. PendingRollbackError; the prompt is the optional part, so it must not be
  3708. the reason the email never goes out.
  3709. """
  3710. try:
  3711. await dispatch_outcome_confirmation(db, printer_id, printer_name, data, archive_id, archive_data)
  3712. except Exception as e:
  3713. logging.getLogger(__name__).error("[NOTIFY-BG] Outcome-confirmation dispatch failed: %s", e, exc_info=True)
  3714. try:
  3715. await db.rollback()
  3716. except Exception:
  3717. pass
  3718. async def dispatch_outcome_confirmation(
  3719. db,
  3720. printer_id: int,
  3721. printer_name: str,
  3722. data: dict,
  3723. archive_id: int,
  3724. archive_data: dict | None = None,
  3725. ) -> bool:
  3726. """Emit the post-print outcome prompt for a completed archive (#1898).
  3727. Gated on the archive itself: ``confirm_requested`` is the opt-in (from the
  3728. queue item, or from ``confirm_outcome_external_prints`` for a print
  3729. Bambuddy did not start) and ``user_verdict`` being unset is what makes the
  3730. question still open. Mints the per-archive capability token the one-tap
  3731. verdict links carry.
  3732. Lives here rather than inline in ``on_print_complete``'s notification task
  3733. because that task swallows every exception: extracted, the gate and the two
  3734. emissions can be driven by a test, which is the only thing standing between
  3735. a regression here and a farm that quietly stops asking.
  3736. Returns whether a prompt was sent.
  3737. """
  3738. logger = logging.getLogger(__name__)
  3739. from backend.app.models.archive import PrintArchive
  3740. confirm_archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  3741. if not (confirm_archive and confirm_archive.confirm_requested and confirm_archive.user_verdict is None):
  3742. return False
  3743. import secrets as _secrets
  3744. # A spent token stays on the row so the one-tap route can recognise it, so
  3745. # "has a token" no longer means "answerable". A prompt going out now needs a
  3746. # live one: mint a new token whenever the stored one is already spent, or
  3747. # every button in the new message would land on the already-answered page.
  3748. if not confirm_archive.confirm_token or confirm_archive.confirm_token_used_at is not None:
  3749. confirm_archive.confirm_token = _secrets.token_urlsafe(32)
  3750. confirm_archive.confirm_token_used_at = None
  3751. await db.commit()
  3752. from backend.app.api.routes.settings import get_external_base_url, get_setting
  3753. base = await get_external_base_url(db)
  3754. if not await get_setting(db, "external_url"):
  3755. # Both the Telegram inline keyboard and the ntfy action buttons need an
  3756. # absolute URL, so an unconfigured install used to get a message body
  3757. # with two unusable relative paths and no buttons at all. The shared
  3758. # fallback at least produces tappable links; say which setting makes
  3759. # them resolve from a phone.
  3760. logger.warning(
  3761. "[#1898] No external_url configured — the outcome prompt's Good/Reject links point at %s. "
  3762. "Set Settings → External URL so they resolve away from this host.",
  3763. base,
  3764. )
  3765. token = confirm_archive.confirm_token
  3766. good_url = f"{base}/api/v1/archives/confirm/{token}/good"
  3767. reject_url = f"{base}/api/v1/archives/confirm/{token}/reject"
  3768. confirm_url = f"{base}/archives?confirm={archive_id}"
  3769. await ws_manager.send_print_confirm_request(
  3770. printer_id,
  3771. {
  3772. "archive_id": archive_id,
  3773. "print_name": confirm_archive.print_name or confirm_archive.filename,
  3774. },
  3775. )
  3776. await notification_service.on_print_confirm_request(
  3777. printer_id,
  3778. printer_name,
  3779. data,
  3780. db,
  3781. archive_data=archive_data,
  3782. good_url=good_url,
  3783. reject_url=reject_url,
  3784. confirm_url=confirm_url,
  3785. archive_id=archive_id,
  3786. )
  3787. return True
  3788. async def _printer_gone(db, printer_id: int) -> bool:
  3789. """Whether the printer was deleted. A column read: the session's loaded
  3790. Printer would otherwise answer for the database."""
  3791. from backend.app.models.printer import Printer
  3792. return await db.scalar(select(Printer.id).where(Printer.id == printer_id)) is None
  3793. async def _drop_archive_of_deleted_printer(db, printer_id: int, archive_id: int) -> bool:
  3794. """Remove the archive just written if its printer was deleted meanwhile.
  3795. The delete route sweeps the printer's archives before it commits, so a row
  3796. committed after that sweep (the check before writing passed while the
  3797. delete was still uncommitted) is left for a printer that will never report
  3798. the print's end. A row the sweep reached is the route's: deleted with the
  3799. printer's archives, or detached (printer_id NULL) when the user kept them,
  3800. and then left as it is. Either way nothing is registered for it. Run after
  3801. the archive's commit, before anything is registered for it.
  3802. """
  3803. from backend.app.models.archive import PrintArchive
  3804. if not await _printer_gone(db, printer_id):
  3805. return False
  3806. owner = await db.scalar(select(PrintArchive.printer_id).where(PrintArchive.id == archive_id))
  3807. if owner == printer_id:
  3808. logging.getLogger(__name__).info(
  3809. "Printer %s was deleted while archive %s was written; removing it", printer_id, archive_id
  3810. )
  3811. await ArchiveService(db).delete_archive(archive_id)
  3812. await forget_printer(printer_id)
  3813. return True
  3814. async def _refused_for_deleted_printer(db, printer_id: int, what: str) -> bool:
  3815. """After an IntegrityError on a print start's archive write: whether it was
  3816. the printer being deleted, forgotten then (the caller returns).
  3817. PostgreSQL: the delete route locks the printer from its archive sweep to its
  3818. commit, so an archive written or adopted for it meanwhile (one that sets
  3819. printer_id) waits and the printer's foreign key then refuses it. That is
  3820. the printer being deleted, not an error; anything else is re-raised by the
  3821. caller.
  3822. """
  3823. await db.rollback()
  3824. if not await _printer_gone(db, printer_id):
  3825. return False
  3826. logging.getLogger(__name__).info("Printer %s was deleted while %s; refused", printer_id, what)
  3827. await forget_printer(printer_id)
  3828. return True
  3829. async def _forget_if_printer_gone(printer_id: int) -> None:
  3830. """At the end of a print start: the slow steps after the last check (smart
  3831. plug, notifications, the timelapse baseline's FTP listing) can outlast the
  3832. printer's delete and its forget_printer, and then wrote state back.
  3833. (An ActivePrintSpoolman row written then is the init_db orphan sweep's on
  3834. SQLite; PostgreSQL refuses it.)
  3835. Its own session: those steps can leave the handler's needing a rollback (a
  3836. write to the archive the delete removed). Never raises: it runs inside the
  3837. fallback branch's try, whose except reports the archive as failed.
  3838. """
  3839. try:
  3840. async with async_session() as db:
  3841. gone = await _printer_gone(db, printer_id)
  3842. if gone:
  3843. await forget_printer(printer_id)
  3844. except Exception:
  3845. logging.getLogger(__name__).warning(
  3846. "Could not check whether printer %s was deleted during its print start", printer_id, exc_info=True
  3847. )
  3848. async def _announce_plate_check_failed(printer_id: int, printer_name: str, reason: str) -> None:
  3849. """Tell the UI a plate check could not run. It does not block the print,
  3850. but an unchecked plate is not an empty one."""
  3851. try:
  3852. await ws_manager.broadcast(
  3853. {"type": "plate_check_failed", "printer_id": printer_id, "printer_name": printer_name, "reason": reason}
  3854. )
  3855. except Exception as e:
  3856. logging.getLogger(__name__).warning("[PLATE CHECK] Could not announce the failed check: %s", e)
  3857. def _expected_print_keys(printer_id: int, filename: str | None, subtask_name: str | None) -> list[tuple[int, str]]:
  3858. """The ``_expected_prints`` keys a print start may be registered under."""
  3859. keys: list[tuple[int, str]] = []
  3860. if subtask_name:
  3861. keys.append((printer_id, subtask_name))
  3862. keys.append((printer_id, f"{subtask_name}.3mf"))
  3863. keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
  3864. if filename:
  3865. fname = filename.split("/")[-1] if "/" in filename else filename
  3866. keys.append((printer_id, fname))
  3867. # Strip extensions to match
  3868. base = fname.replace(".gcode", "").replace(".3mf", "")
  3869. keys.append((printer_id, base))
  3870. keys.append((printer_id, f"{base}.3mf"))
  3871. return keys
  3872. async def _dispatched_by_bambuddy(db, printer_id: int, filename: str | None, subtask_name: str | None) -> bool:
  3873. """Whether this print start is one Bambuddy sent to the printer."""
  3874. if any(key in _expected_prints for key in _expected_print_keys(printer_id, filename, subtask_name)):
  3875. return True
  3876. from backend.app.models.archive import PrintArchive
  3877. from backend.app.models.print_queue import PrintQueueItem
  3878. # The queue row the scheduler sets to printing before it sends -- but only
  3879. # when it was sent as this print: a row left printing by a run whose end
  3880. # was missed names another file.
  3881. dispatched_names = (
  3882. await db.execute(
  3883. select(PrintArchive.filename)
  3884. .join(PrintQueueItem, PrintQueueItem.archive_id == PrintArchive.id)
  3885. .where(PrintQueueItem.printer_id == printer_id, PrintQueueItem.status == "printing")
  3886. )
  3887. ).scalars()
  3888. observed = [name for name in (subtask_name, (filename or "").rsplit("/", 1)[-1]) if name]
  3889. return any(
  3890. _subtask_names_match(_subtask_name_from_filename(dispatched), _subtask_name_from_filename(seen))
  3891. for dispatched in dispatched_names
  3892. if dispatched
  3893. for seen in observed
  3894. )
  3895. async def on_print_start(printer_id: int, data: dict):
  3896. """Handle print start - archive the 3MF file immediately."""
  3897. logger = logging.getLogger(__name__)
  3898. logger.info("[CALLBACK] on_print_start called for printer %s, data keys: %s", printer_id, list(data.keys()))
  3899. try:
  3900. notify_live_activities.print_started(printer_id, printer_manager.get_status(printer_id), data)
  3901. except Exception:
  3902. logger.exception("Notify Live Activity start hook failed for printer %s", printer_id)
  3903. # Clear any stale user-stopped flag from previous print cycles
  3904. _user_stopped_printers.discard(printer_id)
  3905. _kill_switch_stopped.discard(printer_id)
  3906. # A new print starts its milestones from zero (#3211). The status path only
  3907. # resets on progress below 5 while not printing, which a printer that goes
  3908. # from FINISH at 100% straight into a new print at a preparation-phase 85%
  3909. # never shows. This callback does not fire after a Bambuddy restart (#1304)
  3910. # or on resume from pause, so it cannot repeat a milestone mid-print.
  3911. _last_progress_milestone[printer_id] = 0
  3912. _kill_switch_notification_tasks.pop(printer_id, None)
  3913. # #1721: drop any leftover pre-captured finish frame from a prior print
  3914. # so a never-consumed cache entry can't bleed into the new print's photo.
  3915. _stage22_finish_frames.pop(printer_id, None)
  3916. # #1867: same for the in-print frame bank — a queued print must not reuse
  3917. # the previous job's banked frame.
  3918. _inprint_frame_bank.pop(printer_id, None)
  3919. _inprint_frame_bank_ts.pop(printer_id, None)
  3920. # #2547: bind (or clear) the "this print ends with injected End G-code" flag.
  3921. # Unconditional, so a print Bambuddy didn't dispatch drops the previous
  3922. # print's flag instead of inheriting it.
  3923. print_dispatch_context.adopt(printer_id)
  3924. # Cancel any active bed cooldown waiter for this printer
  3925. if _bed_cool_waiters.pop(printer_id, None):
  3926. logger.info("[BED-COOL] Cancelled bed cooldown waiter for printer %s (new print started)", printer_id)
  3927. # Clear cached cover images so the new print's thumbnail is fetched fresh
  3928. from backend.app.api.routes.printers import clear_cover_cache
  3929. clear_cover_cache(printer_id)
  3930. await ws_manager.send_print_start(printer_id, data)
  3931. # Notify when the print-start AMS mapping references tray slots without spool assignments.
  3932. await notify_missing_spool_assignments_on_print_start(printer_id, data, logger)
  3933. # MQTT relay - publish print start
  3934. try:
  3935. printer_info = printer_manager.get_printer(printer_id)
  3936. if printer_info:
  3937. await mqtt_relay.on_print_start(
  3938. printer_id,
  3939. printer_info.name,
  3940. printer_info.serial_number,
  3941. data.get("filename", ""),
  3942. data.get("subtask_name", ""),
  3943. )
  3944. except Exception:
  3945. pass # Don't fail print start callback if MQTT fails
  3946. # Capture AMS tray remain%, the assignment snapshot, the dispatched plate
  3947. # and mapping, and the seeded tray-change log.
  3948. #
  3949. # Unconditional, for both inventory backends. This only *captures* — the
  3950. # writing is still split, with the internal tracker skipped at completion
  3951. # when Spoolman owns usage. Spoolman's own durable row (#1820) already
  3952. # carries its plate-scoped 3MF figures and stored mapping, but not the
  3953. # tray-change log, and that log is the only record of which spool fed
  3954. # which layers when AMS Filament Backup swaps trays mid-print. Capturing
  3955. # it on one side only would leave Spoolman users with the mid-print
  3956. # restart bug this fixes for everyone else.
  3957. try:
  3958. async with async_session() as db:
  3959. from backend.app.api.routes.settings import get_setting
  3960. from backend.app.services.usage_tracker import on_print_start as usage_on_print_start
  3961. _spoolman_on = await get_setting(db, "spoolman_enabled")
  3962. await usage_on_print_start(
  3963. printer_id,
  3964. data,
  3965. printer_manager,
  3966. db=db,
  3967. spoolman_owns_usage=bool(_spoolman_on) and _spoolman_on.lower() == "true",
  3968. )
  3969. except Exception as e:
  3970. logger.warning("Usage tracker on_print_start failed: %s", e)
  3971. # Track if notification was sent (to avoid sending twice)
  3972. notification_sent = False
  3973. # Smart plug automation: turn on plug when print starts
  3974. try:
  3975. async with async_session() as db:
  3976. await smart_plug_manager.on_print_start(printer_id, db)
  3977. except Exception as e:
  3978. logger.warning("Smart plug on_print_start failed: %s", e)
  3979. async with async_session() as db:
  3980. from backend.app.models.printer import Printer
  3981. from backend.app.services.bambu_ftp import list_files_async
  3982. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  3983. printer = result.scalar_one_or_none()
  3984. # Plate detection check - pause if objects detected on build plate
  3985. logger.info(
  3986. f"[PLATE CHECK] printer_id={printer_id}, plate_detection_enabled={printer.plate_detection_enabled if printer else 'NO PRINTER'}"
  3987. )
  3988. if printer and printer.plate_detection_enabled:
  3989. logger.info("[PLATE CHECK] ENTERING plate detection code for printer %s", printer_id)
  3990. # Release the pooled DB connection before the plate-detection camera
  3991. # work (a 2.5s light-settle sleep + FTP/camera capture). Only the
  3992. # printer SELECT has run so far — nothing to persist — so this commit
  3993. # is a data-noop that ends the read transaction and returns the
  3994. # connection to the pool during the I/O (issue #2572). expire_on_commit
  3995. # =False keeps printer.* readable; on_plate_not_empty (rare) and the
  3996. # archive lookups below re-acquire a fresh connection on next execute.
  3997. await db.commit()
  3998. try:
  3999. from backend.app.services.plate_detection import check_plate_empty
  4000. # Build ROI tuple from printer settings if available
  4001. roi = None
  4002. if all(
  4003. [
  4004. printer.plate_detection_roi_x is not None,
  4005. printer.plate_detection_roi_y is not None,
  4006. printer.plate_detection_roi_w is not None,
  4007. printer.plate_detection_roi_h is not None,
  4008. ]
  4009. ):
  4010. roi = (
  4011. printer.plate_detection_roi_x,
  4012. printer.plate_detection_roi_y,
  4013. printer.plate_detection_roi_w,
  4014. printer.plate_detection_roi_h,
  4015. )
  4016. # Auto-turn on chamber light if it's off for better detection
  4017. light_was_off = False
  4018. client = printer_manager.get_client(printer_id)
  4019. if client and client.state:
  4020. light_was_off = not client.state.chamber_light
  4021. if light_was_off:
  4022. logger.info("[PLATE CHECK] Turning on chamber light for printer %s", printer_id)
  4023. client.set_chamber_light(True)
  4024. # Wait for light to physically turn on and camera to adjust exposure
  4025. await asyncio.sleep(2.5)
  4026. plate_photo_data = None
  4027. objects_detected = False
  4028. check_failure: str | None = None
  4029. try:
  4030. logger.info("[PLATE CHECK] Running plate detection for printer %s", printer_id)
  4031. plate_result = await check_plate_empty(
  4032. printer_id=printer_id,
  4033. ip_address=printer.ip_address,
  4034. access_code=printer.access_code,
  4035. model=printer.model,
  4036. include_debug_image=False,
  4037. external_camera_url=printer.external_camera_url,
  4038. external_camera_type=printer.external_camera_type,
  4039. use_external=printer.external_camera_enabled,
  4040. roi=roi,
  4041. external_camera_snapshot_url=printer.external_camera_snapshot_url,
  4042. )
  4043. # No reference to compare against is a check that did not
  4044. # run either: say so rather than call the plate empty.
  4045. check_failure = getattr(plate_result, "failure_reason", None) or (
  4046. "not_calibrated" if plate_result.needs_calibration else None
  4047. )
  4048. objects_detected = not check_failure and not plate_result.is_empty
  4049. if objects_detected:
  4050. # Objects detected - pause the print!
  4051. logger.warning(
  4052. f"[PLATE CHECK] Objects detected on plate for printer {printer_id}! "
  4053. f"Confidence: {plate_result.confidence:.0%}, Diff: {plate_result.difference_percent:.1f}%"
  4054. )
  4055. pause_client = printer_manager.get_client(printer_id)
  4056. if pause_client:
  4057. pause_client.pause_print()
  4058. logger.info("[PLATE CHECK] Print paused for printer %s", printer_id)
  4059. # Snapshot while the light's still on — restoring it first
  4060. # would leave the notification with a dark photo.
  4061. try:
  4062. plate_photo_data = await _capture_snapshot_for_notification(printer_id, printer, logger)
  4063. except Exception as snap_err:
  4064. logger.warning(
  4065. "[PLATE CHECK] Failed to capture snapshot for printer %s: %s", printer_id, snap_err
  4066. )
  4067. finally:
  4068. # Restore chamber light to original state as soon as the
  4069. # camera is done with it, whatever happened above.
  4070. if light_was_off and client:
  4071. logger.info("[PLATE CHECK] Restoring chamber light to off for printer %s", printer_id)
  4072. try:
  4073. client.set_chamber_light(False)
  4074. except Exception as light_err:
  4075. logger.warning(
  4076. "[PLATE CHECK] Failed to restore chamber light for printer %s: %s",
  4077. printer_id,
  4078. light_err,
  4079. )
  4080. if objects_detected:
  4081. # Send notification about plate not empty
  4082. await ws_manager.broadcast(
  4083. {
  4084. "type": "plate_not_empty",
  4085. "printer_id": printer_id,
  4086. "printer_name": printer.name,
  4087. "message": f"Objects detected on build plate! Print paused. (Diff: {plate_result.difference_percent:.1f}%)",
  4088. }
  4089. )
  4090. # Also send push notification
  4091. try:
  4092. await notification_service.on_plate_not_empty(
  4093. printer_id=printer_id,
  4094. printer_name=printer.name,
  4095. db=db,
  4096. difference_percent=plate_result.difference_percent,
  4097. image_data=plate_photo_data,
  4098. )
  4099. except Exception as notif_err:
  4100. logger.warning("[PLATE CHECK] Failed to send notification: %s", notif_err)
  4101. elif check_failure:
  4102. logger.warning(
  4103. "[PLATE CHECK] Plate check could not run for printer %s (%s): %s; proceeding with print",
  4104. printer_id,
  4105. check_failure,
  4106. plate_result.message,
  4107. )
  4108. await _announce_plate_check_failed(printer_id, printer.name, check_failure)
  4109. else:
  4110. logger.info("[PLATE CHECK] Plate is empty for printer %s, proceeding with print", printer_id)
  4111. except Exception as plate_err:
  4112. # Don't block print on plate detection errors
  4113. logger.warning(
  4114. "[PLATE CHECK] Plate check could not run for printer %s: %s; proceeding with print",
  4115. printer_id,
  4116. plate_err,
  4117. )
  4118. await _announce_plate_check_failed(printer_id, printer.name, "error")
  4119. if not printer:
  4120. logger.info("[CALLBACK] Skipping archive - printer not found in database")
  4121. if not notification_sent:
  4122. await _send_print_start_notification(printer_id, data, logger=logger)
  4123. return
  4124. # Skip the printer's own jobs — a calibration run is not a user's print.
  4125. # See is_internal_printer_job for what counts and why both fields are
  4126. # tested; the pressure-advance line reports as a subtask name with no
  4127. # /usr/ path, which the old prefix-only test here missed entirely.
  4128. #
  4129. # No notification either. The event describes the printer calibrating
  4130. # itself, so "Print started" is as wrong as the archive was, and the
  4131. # matching completion is suppressed in on_print_complete for the same
  4132. # reason. Checked before the auto-archive switches, whose "off" path
  4133. # still notifies.
  4134. # A /usr/ path is the printer's own file. A name alone is not proof: a
  4135. # print Bambuddy dispatched is never one, whatever it is called.
  4136. # Dispatched = an expected print, or, after a restart that lost those,
  4137. # a queue job printing on the printer.
  4138. if is_internal_printer_job(data.get("filename", ""), data.get("subtask_name", "")) and (
  4139. (data.get("filename") or "").startswith("/usr/")
  4140. or not await _dispatched_by_bambuddy(db, printer_id, data.get("filename", ""), data.get("subtask_name", ""))
  4141. ):
  4142. logger.info(
  4143. "[CALLBACK] Skipping archive — internal printer job detected: filename=%s, subtask=%s",
  4144. data.get("filename", ""),
  4145. data.get("subtask_name", ""),
  4146. )
  4147. return
  4148. # The global switch is the master: off, no printer archives prints
  4149. # started outside Bambuddy; on, each printer's own switch decides.
  4150. from backend.app.api.routes.settings import get_setting
  4151. _global_auto_archive = await get_setting(db, "auto_archive")
  4152. archives_prints = printer.auto_archive and (
  4153. _global_auto_archive is None or _global_auto_archive.lower() == "true"
  4154. )
  4155. if not archives_prints:
  4156. # auto-archive disabled — check if there's an expected print (dispatched
  4157. # by BamBuddy via queue/reprint) that already has an archive to promote.
  4158. # If so, fall through to the expected-print handling below so the archive
  4159. # is tracked in _active_prints and usage tracking works at completion.
  4160. _fn = data.get("filename", "")
  4161. _sn = data.get("subtask_name", "")
  4162. _check_keys: list[tuple[int, str]] = []
  4163. if _sn:
  4164. _check_keys += [
  4165. (printer_id, _sn),
  4166. (printer_id, f"{_sn}.3mf"),
  4167. (printer_id, f"{_sn}.gcode.3mf"),
  4168. ]
  4169. if _fn:
  4170. _base_fn = _fn.split("/")[-1] if "/" in _fn else _fn
  4171. _check_keys.append((printer_id, _base_fn))
  4172. _no_archive_base = _base_fn.replace(".gcode", "").replace(".3mf", "")
  4173. _check_keys += [
  4174. (printer_id, _no_archive_base),
  4175. (printer_id, f"{_no_archive_base}.3mf"),
  4176. ]
  4177. _has_expected = any(k in _expected_prints for k in _check_keys)
  4178. if not _has_expected:
  4179. # No expected print — truly external print (started from slicer/touchscreen)
  4180. logger.info("[CALLBACK] Skipping archive - auto_archive: False, no expected print")
  4181. if not notification_sent:
  4182. _no_archive_creator: int | None = None
  4183. for _key in _check_keys:
  4184. _expected_prints.pop(_key, None)
  4185. _expected_print_registered_at.pop(_key, None)
  4186. popped_creator = _expected_print_creators.pop(_key, None)
  4187. if _no_archive_creator is None:
  4188. _no_archive_creator = popped_creator
  4189. _creator_data = {"created_by_id": _no_archive_creator} if _no_archive_creator else None
  4190. await _send_print_start_notification(printer_id, data, _creator_data, logger)
  4191. return
  4192. else:
  4193. logger.info("[CALLBACK] auto_archive disabled but expected print found — promoting archive")
  4194. # Get the filename and subtask_name
  4195. filename = data.get("filename", "")
  4196. subtask_name = data.get("subtask_name", "")
  4197. # MQTT subtask_id uniquely identifies a print job on the printer. When
  4198. # present, it lets us match an archive across a backend restart (#972):
  4199. # same id → same print → resume the existing row instead of cancelling
  4200. # it and recreating from scratch (which loses started_at). Treat "0"
  4201. # and "" as absent — Bambu reports "0" for non-cloud / local prints.
  4202. raw_mqtt = data.get("raw_data") or {}
  4203. subtask_id = raw_mqtt.get("subtask_id")
  4204. if subtask_id is not None:
  4205. subtask_id = str(subtask_id).strip()
  4206. if subtask_id in ("", "0"):
  4207. subtask_id = None
  4208. logger.info("[CALLBACK] Print start detected - filename: %s, subtask: %s", filename, subtask_name)
  4209. if not filename and not subtask_name:
  4210. # Send notification without archive data (no filename)
  4211. logger.info("[CALLBACK] Skipping archive - no filename or subtask_name")
  4212. if not notification_sent:
  4213. await _send_print_start_notification(printer_id, data, logger=logger)
  4214. return
  4215. # Check if this is an expected print from reprint/scheduled
  4216. expected_keys = _expected_print_keys(printer_id, filename, subtask_name)
  4217. expected_archive_id = None
  4218. for key in expected_keys:
  4219. expected_archive_id = _expected_prints.pop(key, None)
  4220. _expected_print_registered_at.pop(key, None)
  4221. if expected_archive_id:
  4222. # Clean up other possible keys for this print
  4223. for other_key in expected_keys:
  4224. _expected_prints.pop(other_key, None)
  4225. _expected_print_registered_at.pop(other_key, None)
  4226. break
  4227. if expected_archive_id:
  4228. # This is a reprint/scheduled print - use existing archive, don't create new one
  4229. logger.info("Using expected archive %s for print (skipping duplicate)", expected_archive_id)
  4230. # Bambuddy dispatched it: the kill switch's fast path keeps it as
  4231. # Bambuddy's once the expected entry is consumed here.
  4232. _owned_print_archive_ids.add(expected_archive_id)
  4233. from backend.app.models.archive import PrintArchive
  4234. result = await db.execute(select(PrintArchive).where(PrintArchive.id == expected_archive_id))
  4235. archive = result.scalar_one_or_none()
  4236. # Deleted after this handler loaded it (the plate check waits
  4237. # seconds) but before the route forgot the expected print: the
  4238. # archive the route kept or deleted is left as the route left it.
  4239. if archive and await _printer_gone(db, printer_id):
  4240. logger.info(
  4241. "Printer %s was deleted before its print started; not adopting archive %s", printer_id, archive.id
  4242. )
  4243. await forget_printer(printer_id)
  4244. return
  4245. if archive:
  4246. # As it was before this adoption: put back if the printer turns
  4247. # out to have been deleted while it was adopted (below).
  4248. before_adoption = {
  4249. attr.columns[0].name: getattr(archive, attr.key)
  4250. for attr in sa_inspect(PrintArchive).column_attrs
  4251. if attr.key != "id"
  4252. }
  4253. # Update archive status to printing
  4254. archive.status = "printing"
  4255. archive.started_at = datetime.now(timezone.utc)
  4256. # The previous run's outcome is not this one's: a reprint that
  4257. # completes must not keep showing why the last one failed.
  4258. archive.failure_reason = None
  4259. archive.completed_at = None
  4260. # The previous run's answer is still on this row and the
  4261. # completion prompt is gated on ``user_verdict is None`` (#1898),
  4262. # so without a reset the second run inherits the first run's
  4263. # verdict: no prompt at all, and a green "good" badge on a run
  4264. # nobody ever judged.
  4265. if archive.confirm_requested:
  4266. archive.user_verdict = None
  4267. archive.user_verdict_source = None
  4268. archive.user_verdict_at = None
  4269. archive.confirm_token = None
  4270. archive.confirm_token_used_at = None
  4271. # Reprint of an archive reuses the source row. Without resetting
  4272. # ``timelapse_path`` _scan_for_timelapse_with_retries early-returns
  4273. # ("already has timelapse") and _capture_finish_photo_from_timelapse
  4274. # extracts the *original* print's last frame, which then ships in
  4275. # the completion notification (#1707). Clear the path so the
  4276. # scanner runs fresh; also unlink the old video file so reprints
  4277. # don't accumulate orphans in the archive directory. Photos list
  4278. # is left alone — accumulating one finish photo per run is fine.
  4279. # The print-start baseline (#2704) is stale for the same reason:
  4280. # it describes the printer before the previous run. The capture
  4281. # below overwrites it, but clear it here too so an early failure
  4282. # can't leave the scan diffing against the wrong snapshot.
  4283. #
  4284. # Unlinked only when it is the same plate printing again. Every
  4285. # plate of a Send All shares this archive, and the video on it
  4286. # can be the only copy of another plate's run -- the printer's
  4287. # was deleted once it attached (#3275). That one is left in the
  4288. # archive directory, which goes with the archive. A video whose
  4289. # plate is not on record (attached by hand, or before the
  4290. # column existed) is kept too where the 3MF has other plates,
  4291. # or cannot be read: nothing tells it apart from another plate's,
  4292. # and keeping costs one file where deleting can cost the only
  4293. # copy. On an archive with exactly one plate it is that plate's.
  4294. archive.timelapse_baseline = None
  4295. stale_timelapse_relpath = archive.timelapse_path
  4296. stale_timelapse_plate_id = archive.timelapse_plate_id
  4297. starting_plate_id = _print_plate_ids.get(expected_archive_id)
  4298. if stale_timelapse_relpath:
  4299. archive.timelapse_path = None
  4300. archive.timelapse_plate_id = None
  4301. stale_is_this_plates = stale_timelapse_plate_id == starting_plate_id
  4302. if stale_timelapse_relpath and stale_timelapse_plate_id is None and archive.file_path:
  4303. from backend.app.services.archive import plate_indexes_in_3mf
  4304. plates = await asyncio.to_thread(
  4305. plate_indexes_in_3mf,
  4306. app_settings.base_dir / archive.file_path, # SEC-PATH-OK: stored relative archive path
  4307. )
  4308. stale_is_this_plates = len(plates) == 1
  4309. if stale_timelapse_relpath and not stale_is_this_plates:
  4310. logger.info(
  4311. "Kept timelapse %s of plate %s on archive %s: plate %s is starting",
  4312. stale_timelapse_relpath,
  4313. stale_timelapse_plate_id,
  4314. expected_archive_id,
  4315. starting_plate_id,
  4316. )
  4317. # The video is deleted once the adoption stands (below).
  4318. delete_stale_video = bool(stale_timelapse_relpath) and stale_is_this_plates
  4319. # Persist a restart-stable id so a later restart resumes this
  4320. # archive by subtask_id instead of name-matching + duplicating
  4321. # it (#1485). The printer often hasn't echoed subtask_id back
  4322. # this soon after dispatch, so fall back to the id Bambuddy
  4323. # minted when it sent the print command. Scoped to this
  4324. # expected-print branch on purpose: an expected match means
  4325. # Bambuddy dispatched this exact print in this process, so the
  4326. # client's last-dispatch id genuinely belongs to it — using it
  4327. # for an externally-started print could mis-tag the archive.
  4328. effective_subtask_id = subtask_id
  4329. if not effective_subtask_id:
  4330. _client = printer_manager.get_client(printer_id)
  4331. _dispatched = getattr(_client, "last_dispatch_subtask_id", None) if _client else None
  4332. if _dispatched:
  4333. effective_subtask_id = str(_dispatched).strip() or None
  4334. # Update on first-set OR on reprint (the queue dispatcher mints
  4335. # a fresh subtask_id per dispatch in bambu_mqtt:3647). Skipping
  4336. # the rewrite for reprints leaves the archive holding the FIRST
  4337. # run's id; if MQTT then reconnects mid-print, the reconciler
  4338. # (#1542) compares the stale stored id against the printer's
  4339. # live id, sees a mismatch, and synthesises a bogus PRINT
  4340. # COMPLETE — exactly the false-positive "Print Stopped" reported
  4341. # in #1807. Inequality check preserves the noop-on-stable-push
  4342. # behaviour the earlier `not archive.subtask_id` guard provided.
  4343. if effective_subtask_id and archive.subtask_id != effective_subtask_id:
  4344. archive.subtask_id = effective_subtask_id
  4345. # #1403 follow-up: VP-queue archives are created with
  4346. # printer_id=None at queue-add time (we don't know which
  4347. # printer will run the job yet). When the print actually
  4348. # starts on a specific printer the expected-archive lookup
  4349. # used to skip this assignment, leaving printer_id=None
  4350. # forever — which then disables the "Scan for timelapse"
  4351. # button in ArchivesPage (gated on !archive.printer_id).
  4352. if archive.printer_id != printer_id:
  4353. archive.printer_id = printer_id
  4354. adopting_id = archive.id # a rollback expires the object
  4355. try:
  4356. await db.commit()
  4357. except (IntegrityError, StaleDataError):
  4358. # The archive stays unchanged, or is gone: "delete archives"
  4359. # removed the row under the adoption, which then matched no
  4360. # row (StaleDataError) rather than being refused.
  4361. if await _refused_for_deleted_printer(db, printer_id, f"archive {adopting_id} was adopted"):
  4362. return
  4363. raise
  4364. # The printer can be deleted between the check above and this
  4365. # commit (the route's transaction lasts seconds), and the commit
  4366. # then adopted the archive anyway: status, verdict and timelapse
  4367. # changed, and the deleted printer's id written on a row the
  4368. # route had detached or never touched. Undo the adoption.
  4369. if await _printer_gone(db, printer_id):
  4370. logger.info(
  4371. "Printer %s was deleted while archive %s was adopted; undoing the adoption",
  4372. printer_id,
  4373. archive.id,
  4374. )
  4375. # Everything as before this adoption. The printer it had
  4376. # then stays, unless it was the deleted one: the route
  4377. # detached that row (kept) or deleted it (no row matches).
  4378. previous_printer = before_adoption["printer_id"]
  4379. await db.execute(
  4380. update(PrintArchive)
  4381. .where(PrintArchive.id == archive.id)
  4382. .values(
  4383. {
  4384. **before_adoption,
  4385. "printer_id": None if previous_printer == printer_id else previous_printer,
  4386. }
  4387. )
  4388. )
  4389. await db.commit()
  4390. await forget_printer(printer_id)
  4391. return
  4392. if delete_stale_video and stale_timelapse_relpath:
  4393. try:
  4394. stale_path = app_settings.base_dir / stale_timelapse_relpath
  4395. if stale_path.is_file():
  4396. stale_path.unlink()
  4397. logger.info(
  4398. "Deleted stale timelapse %s on reprint of archive %s",
  4399. stale_timelapse_relpath,
  4400. expected_archive_id,
  4401. )
  4402. except OSError as e:
  4403. logger.warning(
  4404. "Failed to delete stale timelapse %s on reprint: %s",
  4405. stale_timelapse_relpath,
  4406. e,
  4407. )
  4408. # Track as active print
  4409. _bind_active_print(printer_id, archive.id, archive.filename, filename, subtask_name)
  4410. # Start timelapse session if external camera is enabled (#1353).
  4411. # Queue / VP-dispatched prints land here in the expected-archive
  4412. # branch and used to skip start_session entirely — frames were
  4413. # never captured and the post-print stitch silently returned None.
  4414. _maybe_start_layer_timelapse(printer, printer_id, archive.id)
  4415. # Inject ams_mapping into usage tracker session — the session was created
  4416. # before expected-print promotion, so it may have ams_mapping=None when
  4417. # the MQTT request topic subscription failed (common on P1S/A1).
  4418. _stored_map = _print_ams_mappings.get(expected_archive_id)
  4419. _stored_plate_id = _print_plate_ids.get(expected_archive_id)
  4420. if _stored_map or _stored_plate_id is not None:
  4421. try:
  4422. from backend.app.services.usage_tracker import _active_sessions
  4423. _ut_session = _active_sessions.get(printer_id)
  4424. if _ut_session and _stored_map and not _ut_session.ams_mapping:
  4425. _ut_session.ams_mapping = _stored_map
  4426. logger.info("[CALLBACK] Injected ams_mapping into usage tracker session: %s", _stored_map)
  4427. # plate_id injection covers direct-Print of plate N of a multi-plate
  4428. # 3MF — queue prints already capture it via the on_print_start queue
  4429. # lookup, but direct-Print never goes through the queue (#1697).
  4430. if _ut_session and _stored_plate_id is not None and _ut_session.plate_id is None:
  4431. _ut_session.plate_id = _stored_plate_id
  4432. logger.info("[CALLBACK] Injected plate_id into usage tracker session: %s", _stored_plate_id)
  4433. except Exception:
  4434. pass
  4435. # Set up energy tracking (#941: persist start on archive row)
  4436. await _record_energy_start(archive, printer_id, db, context="expected-print")
  4437. await ws_manager.send_archive_updated(
  4438. {
  4439. "id": archive.id,
  4440. "status": "printing",
  4441. }
  4442. )
  4443. # Send notification with archive data (reprint/scheduled)
  4444. if not notification_sent:
  4445. # Use archive's created_by_id; fall back to the creator registered via
  4446. # register_expected_print (handles library-file-based queue items where
  4447. # the freshly-created archive has no created_by_id yet).
  4448. # Pop ALL matching keys so no stale entries remain in the dict.
  4449. fallback_creator = None
  4450. for key in expected_keys:
  4451. popped = _expected_print_creators.pop(key, None)
  4452. if fallback_creator is None:
  4453. fallback_creator = popped
  4454. archive_data = {
  4455. "print_time_seconds": archive.print_time_seconds,
  4456. "created_by_id": archive.created_by_id or fallback_creator,
  4457. }
  4458. await _send_print_start_notification(printer_id, data, archive_data, logger)
  4459. # Extract printable objects from the archived 3MF file
  4460. _load_objects_from_archive(archive, printer_id, logger)
  4461. # Store Spoolman tracking data for per-filament usage reporting
  4462. try:
  4463. await _store_spoolman_print_data(
  4464. printer_id,
  4465. archive.id,
  4466. archive.file_path,
  4467. db,
  4468. printer_manager,
  4469. ams_mapping=_get_start_ams_mapping(data, archive.id),
  4470. plate_id=_get_start_plate_id(archive.id),
  4471. )
  4472. except Exception as e:
  4473. logger.warning("[SPOOLMAN] Failed to store tracking data: %s", e)
  4474. # Price the print from its spools now rather than only at completion (#3261)
  4475. _schedule_archive_cost_estimate(
  4476. printer_id,
  4477. archive.id,
  4478. printer_manager,
  4479. ams_mapping=_get_start_ams_mapping(data, archive.id),
  4480. plate_id=_get_start_plate_id(archive.id),
  4481. session_factory=async_session,
  4482. )
  4483. # Capture timelapse file baseline for snapshot-diff on completion
  4484. # (mirrors the new-archive branch). Queue / VP-dispatched prints
  4485. # hit this branch — without the baseline the completion-time scan
  4486. # falls into its "take baseline now" fallback, which snapshots
  4487. # AFTER the new MP4 already exists and never matches a diff
  4488. # (#1403 follow-up — see pwostran's 2026-05-18 support bundle).
  4489. await _capture_timelapse_baseline_at_start(printer, printer_id, logger, archive_id=archive.id)
  4490. await _forget_if_printer_gone(printer_id)
  4491. return # Skip creating a new archive
  4492. # The archive was deleted after the job was queued.
  4493. if not archives_prints:
  4494. # Only the expected print brought a printer that does not
  4495. # archive this far; with it gone, nothing is archived.
  4496. return
  4497. # Otherwise archive the print anew rather than drop it, so it still
  4498. # gets its notification, usage tracking and history.
  4499. logger.warning(
  4500. "Expected archive %s for printer %s no longer exists; archiving the print anew",
  4501. expected_archive_id,
  4502. printer_id,
  4503. )
  4504. # Check if there's already a "printing" archive for this printer/file
  4505. # This prevents duplicates when backend restarts during an active print
  4506. from backend.app.models.archive import PrintArchive
  4507. existing_archive: PrintArchive | None = None
  4508. # Preferred match: subtask_id equality. MQTT reports the same subtask_id
  4509. # across a backend restart for the same print, so this is the most
  4510. # reliable way to reattach. Only a row still printing: a cancelled one
  4511. # has been through completion (usage, history, notifications) already,
  4512. # and reopening it would count the print twice.
  4513. if subtask_id:
  4514. by_id = await db.execute(
  4515. select(PrintArchive)
  4516. .where(PrintArchive.printer_id == printer_id)
  4517. .where(PrintArchive.subtask_id == subtask_id)
  4518. .where(PrintArchive.status == "printing")
  4519. .order_by(PrintArchive.created_at.desc())
  4520. .limit(1)
  4521. )
  4522. existing_archive = by_id.scalar_one_or_none()
  4523. # Fallback match: name-based lookup. Kept as-is for prints whose
  4524. # subtask_id is missing ("0" / local / non-cloud prints).
  4525. if existing_archive is None:
  4526. check_name = subtask_name or filename.split("/")[-1].replace(".gcode", "").replace(".3mf", "")
  4527. archive_filenames = [f"{check_name}.3mf", f"{check_name}.gcode.3mf"]
  4528. # A print started from the printer's screen names its file in full,
  4529. # so the forms above double its extension. The file itself is the
  4530. # one exact match, and nothing looser is added (#3009).
  4531. if _subtask_is_the_file(subtask_name, filename):
  4532. archive_filenames.append(subtask_name)
  4533. existing = await db.execute(
  4534. select(PrintArchive)
  4535. .where(PrintArchive.printer_id == printer_id)
  4536. .where(PrintArchive.status == "printing")
  4537. .where(
  4538. or_(
  4539. PrintArchive.print_name == check_name,
  4540. PrintArchive.filename.in_(archive_filenames),
  4541. )
  4542. )
  4543. .order_by(PrintArchive.created_at.desc())
  4544. .limit(1)
  4545. )
  4546. existing_archive = existing.scalar_one_or_none()
  4547. if existing_archive:
  4548. # subtask_id match → always resume, regardless of age. Same print,
  4549. # just a backend restart.
  4550. subtask_match = bool(subtask_id and existing_archive.subtask_id == subtask_id)
  4551. if subtask_match:
  4552. logger.info("Resuming archive %s on subtask_id match (%s)", existing_archive.id, subtask_id)
  4553. _bind_active_print(printer_id, existing_archive.id, existing_archive.filename, filename, subtask_name)
  4554. _mark_owned_if_dispatched(existing_archive)
  4555. if existing_archive.energy_start_kwh is None:
  4556. await _record_energy_start(existing_archive, printer_id, db, context="subtask-resume")
  4557. if not notification_sent:
  4558. archive_data = {
  4559. "print_time_seconds": existing_archive.print_time_seconds,
  4560. "created_by_id": existing_archive.created_by_id,
  4561. }
  4562. await _send_print_start_notification(printer_id, data, archive_data, logger)
  4563. _load_objects_from_archive(existing_archive, printer_id, logger)
  4564. return
  4565. # Name-match only (no subtask_id to anchor on): decide resume vs.
  4566. # stale from the printer's *current* progress, not wall-clock age.
  4567. # A genuinely long print used to trip a blind 4h cutoff and have its
  4568. # live archive cancelled + duplicated on every backend restart
  4569. # (#1485). If the printer reports real progress, this name-matched
  4570. # 'printing' archive IS that ongoing print — resume it whatever its
  4571. # age. Only treat it as a stale leftover when the printer clearly
  4572. # shows a different, freshly-started print: near-0% progress on an
  4573. # archive far too old to still be at 0%. Unknown progress (printer
  4574. # not connected) never cancels — resuming is the safe default.
  4575. archive_age = datetime.now(timezone.utc) - existing_archive.created_at.replace(tzinfo=timezone.utc)
  4576. live_status = printer_manager.get_status(printer_id)
  4577. live_progress = getattr(live_status, "progress", None) if live_status else None
  4578. looks_stale = (
  4579. live_progress is not None and live_progress < 1.0 and archive_age.total_seconds() > 2 * 60 * 60
  4580. )
  4581. # Two subtask ids are two prints, however young the archive: one
  4582. # whose completion was missed must not swallow the next print of
  4583. # the same file. Except Bambuddy's own reprint, which reuses the
  4584. # row and mints a fresh id (#1807): the id it last sent says so,
  4585. # and after a restart, which forgets it, this printer's queue job
  4586. # running the archive.
  4587. if (
  4588. not looks_stale
  4589. and subtask_id
  4590. and existing_archive.subtask_id
  4591. and existing_archive.subtask_id != subtask_id
  4592. ):
  4593. _client = printer_manager.get_client(printer_id)
  4594. _dispatched = str(getattr(_client, "last_dispatch_subtask_id", None) or "").strip()
  4595. if _dispatched:
  4596. looks_stale = _dispatched != subtask_id
  4597. else:
  4598. from backend.app.models.print_queue import PrintQueueItem as _PQI
  4599. queue_run = await db.scalar(
  4600. select(_PQI.id)
  4601. .where(_PQI.archive_id == existing_archive.id)
  4602. .where(_PQI.printer_id == printer_id)
  4603. .where(_PQI.status == "printing")
  4604. .limit(1)
  4605. )
  4606. looks_stale = queue_run is None
  4607. if looks_stale:
  4608. logger.warning(
  4609. "Found stale 'printing' archive %s (age: %s, printer progress %s%%, subtask %s, printer reports %s)"
  4610. " — marking cancelled and creating new archive",
  4611. existing_archive.id,
  4612. archive_age,
  4613. live_progress,
  4614. existing_archive.subtask_id,
  4615. subtask_id,
  4616. )
  4617. existing_archive.status = "cancelled"
  4618. # Canonical key, not a sentence (issue #2974). "No status update
  4619. # received" is what both stale paths actually observed; which of
  4620. # the two it was is already carried by ``status`` -- cancelled
  4621. # here, the reconciled outcome at the reconnect site -- so one
  4622. # key loses no information and gives the Statistics breakdown a
  4623. # single bucket instead of two untranslatable prose strings.
  4624. existing_archive.failure_reason = "noStatusUpdate"
  4625. await db.commit()
  4626. # Its print keys go with it; the new archive registers its own.
  4627. for _key in [k for k, v in _active_prints.items() if v == existing_archive.id]:
  4628. del _active_prints[_key]
  4629. # Fall through to create new archive (don't return)
  4630. else:
  4631. logger.info(
  4632. f"Skipping duplicate - already have printing archive {existing_archive.id} for {check_name}"
  4633. )
  4634. # Track this as the active print
  4635. _bind_active_print(printer_id, existing_archive.id, existing_archive.filename, filename, subtask_name)
  4636. _mark_owned_if_dispatched(existing_archive)
  4637. # Attach subtask_id retroactively so future restarts can resume.
  4638. # Compare for inequality (not "is empty") to also pick up reprint
  4639. # dispatches that mint a fresh id — see #1807 for the bogus
  4640. # "Print Stopped" the strict-empty guard caused on reconnect.
  4641. if subtask_id and existing_archive.subtask_id != subtask_id:
  4642. existing_archive.subtask_id = subtask_id
  4643. await db.commit()
  4644. # Also set up energy tracking if not already tracked (#941: persisted column)
  4645. if existing_archive.energy_start_kwh is None:
  4646. await _record_energy_start(existing_archive, printer_id, db, context="existing-printing")
  4647. # Send notification with archive data (existing archive)
  4648. if not notification_sent:
  4649. archive_data = {
  4650. "print_time_seconds": existing_archive.print_time_seconds,
  4651. "created_by_id": existing_archive.created_by_id,
  4652. }
  4653. await _send_print_start_notification(printer_id, data, archive_data, logger)
  4654. # Extract printable objects from the archived 3MF file
  4655. _load_objects_from_archive(existing_archive, printer_id, logger)
  4656. return
  4657. # Build list of possible 3MF filenames to try
  4658. possible_names = []
  4659. # Bambu printers typically store files as "Name.gcode.3mf"
  4660. # The subtask_name is usually the best source for the filename
  4661. if subtask_name:
  4662. if _subtask_is_the_file(subtask_name, filename):
  4663. # A print started from the printer's own screen reports the
  4664. # file's full name, extension included. That is the file, so
  4665. # no extension is appended to it (#3009).
  4666. possible_names.append(subtask_name)
  4667. else:
  4668. # Try common Bambu naming patterns
  4669. possible_names.append(f"{subtask_name}.gcode.3mf")
  4670. possible_names.append(f"{subtask_name}.3mf")
  4671. # Try original filename with .3mf extension
  4672. if filename:
  4673. # Extract just the filename part, not the full path
  4674. fname = filename.split("/")[-1] if "/" in filename else filename
  4675. if fname.endswith(".3mf"):
  4676. possible_names.append(fname)
  4677. elif fname.endswith(".gcode"):
  4678. base = fname.rsplit(".", 1)[0]
  4679. possible_names.append(f"{base}.gcode.3mf")
  4680. possible_names.append(f"{base}.3mf")
  4681. else:
  4682. possible_names.append(f"{fname}.gcode.3mf")
  4683. possible_names.append(f"{fname}.3mf")
  4684. # Also try with spaces converted to underscores (Bambu Studio may normalize filenames)
  4685. space_variants = []
  4686. for name in possible_names:
  4687. if " " in name:
  4688. space_variants.append(name.replace(" ", "_"))
  4689. possible_names.extend(space_variants)
  4690. # Remove duplicates while preserving order
  4691. seen = set()
  4692. possible_names = [x for x in possible_names if not (x in seen or seen.add(x))]
  4693. logger.info("Trying filenames: %s", possible_names)
  4694. # Release the pooled DB connection before the 3MF FTP download. Reaching
  4695. # here means none of the expected-/existing-archive write branches ran
  4696. # (they all return earlier) — only SELECTs have executed on this path, so
  4697. # this commit persists nothing; it ends the read transaction so the
  4698. # connection returns to the pool during the download. That download tries
  4699. # up to five remote paths per candidate filename with retry/backoff and
  4700. # can run for minutes under FTP contention; holding the session across it
  4701. # pinned one pooled connection idle-in-transaction (issue #2572). No DB
  4702. # work runs during the download — the new-archive writes below re-acquire
  4703. # a fresh connection, and expire_on_commit=False keeps printer.* readable.
  4704. await db.commit()
  4705. # Try to find and download the 3MF file
  4706. temp_path = None
  4707. downloaded_filename = None
  4708. # Cache check: cover endpoint may have already pulled this 3MF during
  4709. # the print (frontend opens the card and shows the thumbnail) — reuse
  4710. # that file instead of re-downloading 36MB over the same FTP link that
  4711. # just served it (#972). The cache keys on a normalized filename so
  4712. # variants like "X", "X.3mf", "X.gcode.3mf" all collapse to one entry.
  4713. for try_filename in possible_names:
  4714. if not try_filename.endswith(".3mf"):
  4715. continue
  4716. cached = get_cached_3mf(printer_id, try_filename)
  4717. if cached:
  4718. logger.info("Reusing cached 3MF from %s (avoided duplicate FTP)", cached)
  4719. temp_path = cached
  4720. downloaded_filename = try_filename
  4721. break
  4722. # Does this printer keep the sliced file somewhere FTPS can reach? On
  4723. # H2-series and P2S the answer is routinely no — the file stays on
  4724. # internal eMMC and port 990 only ever serves external storage — and
  4725. # then the whole sweep below (six filenames x five directories x four
  4726. # retries, then the directory walk) is ~110 connections that cannot
  4727. # succeed. Skip it and say why (#2780).
  4728. storage = print_file_reachable_over_ftp(printer_manager.get_status(printer_id))
  4729. # Set when a lookup is abandoned because the printer's FTPS cool-off is
  4730. # running rather than because the file is somewhere unreachable. The
  4731. # distinction is the whole of #2957: one is permanent, the other clears
  4732. # in minutes with the file still sitting on the printer.
  4733. blocked_by_ftps_cooloff = False
  4734. # Set when a probe reached the printer and still came back without the
  4735. # file -- a timeout mid-transfer, a refused connection, anything that is
  4736. # not a clean "not here". A 550 raises FileNotOnPrinterError and is
  4737. # caught by name below, so a file that genuinely is not on the card
  4738. # leaves this False and schedules nothing. Anything else means the
  4739. # transfer, not the file, is what failed, and that does not last (#3063).
  4740. ftp_transfer_failed = False
  4741. # The print's name, for a fallback archive whose `subtask_name` the
  4742. # plate guard below had to disown. Display only, and deliberately kept
  4743. # apart from `subtask_name`: that variable is what every file lookup
  4744. # here is built from, and once a name has been shown to fetch another
  4745. # plate's 3MF it must not key `_active_prints` either, or the cover
  4746. # endpoint hands the same contradicted file to
  4747. # `_recover_fallback_archive` and fills the row in with it (#3126).
  4748. display_name_after_plate_reject: str | None = None
  4749. # Get FTP retry settings
  4750. ftp_retry_enabled, ftp_retry_count, ftp_retry_delay, ftp_timeout = await get_ftp_retry_settings()
  4751. # ...but "the printer put it on eMMC" is where it went, not whether we
  4752. # can read it. An H2D with a card in mirrors the job to /cache and
  4753. # serves it happily, and skipping on the URL alone cost that reporter
  4754. # every archive for two days (#2856). So ask the printer instead of
  4755. # guessing: the dispatch named the exact file, which is one connection
  4756. # walking five paths rather than the sweep's ~110. Only when the probe
  4757. # comes back empty does the verdict's reason stand.
  4758. if not storage.reachable and not downloaded_filename and storage.probe_filename:
  4759. if ftps_handshake_blocked(printer.ip_address):
  4760. # Deliberately NOT recorded as a cool-off give-up. This branch
  4761. # only runs on an unreachable verdict, and that verdict is the
  4762. # honest, permanent reason the archive is empty — the probe was
  4763. # a long shot on top of it. Blaming the cool-off here would
  4764. # schedule a retry for a file sitting on internal eMMC, which is
  4765. # the sweep #2780 removed (#2957).
  4766. logger.debug(
  4767. "Not probing for %s on printer %s: its file service is not answering over TLS",
  4768. storage.probe_filename,
  4769. printer_id,
  4770. )
  4771. else:
  4772. probe_path = app_settings.archive_dir / "temp" / storage.probe_filename
  4773. probe_path.parent.mkdir(parents=True, exist_ok=True)
  4774. try:
  4775. probe_hit = await download_file_try_paths_async(
  4776. printer.ip_address,
  4777. printer.access_code,
  4778. ftp_probe_paths(storage.probe_filename),
  4779. probe_path,
  4780. socket_timeout=ftp_timeout,
  4781. printer_model=printer.model,
  4782. )
  4783. except Exception as e:
  4784. logger.debug("3MF probe for %s failed: %s", storage.probe_filename, e)
  4785. probe_hit = False
  4786. if probe_hit:
  4787. downloaded_filename = storage.probe_filename
  4788. temp_path = probe_path
  4789. cache_3mf_download(printer_id, downloaded_filename, probe_path)
  4790. # Naming the path, not just the file: a printer that keeps
  4791. # uploads around for weeks can serve a same-named copy of an
  4792. # earlier slice, and without the directory in the log that
  4793. # mismatch is invisible rather than merely rare (#1820).
  4794. logger.info(
  4795. "Found %s at %s over FTPS for printer %s even though the printer reported %s",
  4796. downloaded_filename,
  4797. probe_hit,
  4798. printer_id,
  4799. storage.reason,
  4800. )
  4801. if not storage.reachable and not downloaded_filename:
  4802. # Same opening words whether or not a probe ran, because that is
  4803. # the phrase support asks people to grep for — only the tail says
  4804. # which of the two happened.
  4805. logger.info(
  4806. "Skipping the 3MF lookup for printer %s: %s — %s",
  4807. printer_id,
  4808. storage.reason,
  4809. "no copy of it on external storage either"
  4810. if storage.probe_filename
  4811. else "the print file is not on storage Bambuddy can read over FTPS, so no path would find it",
  4812. )
  4813. for try_filename in possible_names if not downloaded_filename and storage.reachable else []:
  4814. if not try_filename.endswith(".3mf"):
  4815. continue
  4816. # Root (/) is where BambuStudio/OrcaSlicer uploads land on A1/P1-series
  4817. # printers, so try it first — deferring it to last cost #972's reporter
  4818. # ~48 minutes of retries on /cache//model//data//data/Metadata before
  4819. # landing on the path that actually had the file.
  4820. remote_paths = [
  4821. f"/{try_filename}",
  4822. f"/cache/{try_filename}",
  4823. f"/model/{try_filename}",
  4824. f"/data/{try_filename}",
  4825. f"/data/Metadata/{try_filename}",
  4826. ]
  4827. temp_path = app_settings.archive_dir / "temp" / try_filename
  4828. temp_path.parent.mkdir(parents=True, exist_ok=True)
  4829. for remote_path in remote_paths:
  4830. if ftps_handshake_blocked(printer.ip_address):
  4831. # The printer's FTPS service is not completing a TLS
  4832. # handshake, so it has no path we could reach — walking the
  4833. # remaining candidates only re-runs the same failure
  4834. # (#2780). Fall through to the no-3MF archive now.
  4835. #
  4836. # Remember *why*, though. This is the one give-up that is
  4837. # temporary: the cool-off clears in minutes and the file was
  4838. # on the printer the whole time. The fallback archive is
  4839. # stamped with it so a retry can be scheduled, and so the
  4840. # Archives banner stops blaming storage (#2957).
  4841. blocked_by_ftps_cooloff = True
  4842. logger.warning(
  4843. "Giving up on the 3MF for printer %s: its file service is not answering over TLS",
  4844. printer_id,
  4845. )
  4846. break
  4847. logger.debug("Trying FTP download: %s", remote_path)
  4848. try:
  4849. if ftp_retry_enabled:
  4850. downloaded = await with_ftp_retry(
  4851. download_file_async,
  4852. printer.ip_address,
  4853. printer.access_code,
  4854. remote_path,
  4855. temp_path,
  4856. timeout=ftp_timeout,
  4857. socket_timeout=ftp_timeout,
  4858. printer_model=printer.model,
  4859. max_retries=ftp_retry_count,
  4860. retry_delay=ftp_retry_delay,
  4861. operation_name=f"Download 3MF from {remote_path}",
  4862. cooloff_ip=printer.ip_address,
  4863. non_retry_exceptions=(FileNotOnPrinterError,),
  4864. )
  4865. else:
  4866. downloaded = await download_file_async(
  4867. printer.ip_address,
  4868. printer.access_code,
  4869. remote_path,
  4870. temp_path,
  4871. timeout=ftp_timeout,
  4872. socket_timeout=ftp_timeout,
  4873. printer_model=printer.model,
  4874. )
  4875. if downloaded:
  4876. downloaded_filename = try_filename
  4877. logger.info("Downloaded: %s", remote_path)
  4878. # Populate shared cache so the cover endpoint (if it
  4879. # runs next) doesn't refetch the same 36MB over FTP.
  4880. cache_3mf_download(printer_id, try_filename, temp_path)
  4881. break
  4882. # with_ftp_retry returns None once it has spent its budget,
  4883. # and download_file_async returns False on a timeout, so an
  4884. # exhausted transfer arrives here rather than as an
  4885. # exception (#3063).
  4886. ftp_transfer_failed = True
  4887. except FileNotOnPrinterError:
  4888. # 550 — file isn't at this path. Advance to next candidate
  4889. # without burning the retry budget.
  4890. logger.debug("3MF not at %s (550), trying next path", remote_path)
  4891. except Exception as e:
  4892. ftp_transfer_failed = True
  4893. logger.debug("FTP download failed for %s: %s", remote_path, e)
  4894. if downloaded_filename or ftps_handshake_blocked(printer.ip_address):
  4895. break
  4896. # If still not found, try listing directories to find matching file
  4897. # Different printer models use different directory structures. Skipped
  4898. # when the printer's FTPS handshake is failing — the directory walk is
  4899. # five more connections that cannot get further than the download did.
  4900. if (
  4901. not downloaded_filename
  4902. and storage.reachable
  4903. and (filename or subtask_name)
  4904. and not ftps_handshake_blocked(printer.ip_address)
  4905. ):
  4906. search_term = (subtask_name or filename).lower().replace(".gcode", "").replace(".3mf", "")
  4907. logger.info("Direct FTP download failed, searching directories for '%s'", search_term)
  4908. search_dirs = ["/cache", "/model", "/data", "/data/Metadata", "/"]
  4909. # Every folder is listed before one file is picked, so a file named
  4910. # for the print in a later folder wins over one that merely
  4911. # contains the name in an earlier folder.
  4912. listed_paths: list[str] = []
  4913. for search_dir in search_dirs:
  4914. try:
  4915. dir_files = await list_files_async(
  4916. printer.ip_address, printer.access_code, search_dir, printer_model=printer.model
  4917. )
  4918. except Exception as e:
  4919. logger.debug("Failed to list %s: %s", search_dir, e)
  4920. continue
  4921. threemf_files = [f.get("name") for f in dir_files if f.get("name", "").endswith(".3mf")]
  4922. if threemf_files:
  4923. logger.info(
  4924. f"Found {len(threemf_files)} 3MF files in {search_dir}: {threemf_files[:5]}{'...' if len(threemf_files) > 5 else ''}"
  4925. )
  4926. listed_paths += [
  4927. posixpath.join(search_dir, f.get("name", "")) for f in dir_files if not f.get("is_directory")
  4928. ]
  4929. for remote_full_path in _3mf_files_for_print(listed_paths, search_term):
  4930. fname = posixpath.basename(remote_full_path)
  4931. logger.info("Found matching file: %s", remote_full_path)
  4932. temp_path = app_settings.archive_dir / "temp" / fname
  4933. temp_path.parent.mkdir(parents=True, exist_ok=True)
  4934. try:
  4935. if ftp_retry_enabled:
  4936. downloaded = await with_ftp_retry(
  4937. download_file_async,
  4938. printer.ip_address,
  4939. printer.access_code,
  4940. remote_full_path,
  4941. temp_path,
  4942. timeout=ftp_timeout,
  4943. socket_timeout=ftp_timeout,
  4944. printer_model=printer.model,
  4945. max_retries=ftp_retry_count,
  4946. retry_delay=ftp_retry_delay,
  4947. operation_name=f"Download 3MF from {remote_full_path}",
  4948. cooloff_ip=printer.ip_address,
  4949. )
  4950. else:
  4951. downloaded = await download_file_async(
  4952. printer.ip_address,
  4953. printer.access_code,
  4954. remote_full_path,
  4955. temp_path,
  4956. timeout=ftp_timeout,
  4957. socket_timeout=ftp_timeout,
  4958. printer_model=printer.model,
  4959. )
  4960. except Exception as e:
  4961. logger.debug("Failed to download %s: %s", remote_full_path, e)
  4962. continue
  4963. if downloaded:
  4964. downloaded_filename = fname
  4965. logger.info("Found and downloaded: %s", remote_full_path)
  4966. cache_3mf_download(printer_id, fname, temp_path)
  4967. break
  4968. # The listing named the file, so it is on the card;
  4969. # only the transfer failed (#3063).
  4970. ftp_transfer_failed = True
  4971. # Validate the downloaded 3MF actually matches the plate that's running
  4972. # (#1204): subtask_name lags across consecutive plates of the same model,
  4973. # so the first FTP candidate (built from subtask_name) can land on the
  4974. # previous plate's still-resident upload. Cross-check the slice_info
  4975. # plate index against the plate parsed from gcode_file (always fresh —
  4976. # it's the field whose change triggered this callback).
  4977. if downloaded_filename and temp_path:
  4978. expected_plate = parse_plate_id(filename)
  4979. actual_plate = peek_plate_index_in_3mf(temp_path) if expected_plate is not None else None
  4980. if expected_plate is not None and actual_plate is not None and actual_plate != expected_plate:
  4981. logger.warning(
  4982. "[CALLBACK] 3MF plate mismatch: downloaded %s reports plate %s but printer is "
  4983. "running plate %s — subtask_name=%r appears stale, retrying with corrected name",
  4984. downloaded_filename,
  4985. actual_plate,
  4986. expected_plate,
  4987. subtask_name,
  4988. )
  4989. corrected_subtask = swap_plate_suffix(subtask_name, expected_plate)
  4990. retry_succeeded = False
  4991. if corrected_subtask and corrected_subtask != subtask_name:
  4992. for try_filename in (f"{corrected_subtask}.gcode.3mf", f"{corrected_subtask}.3mf"):
  4993. retry_temp_path = app_settings.archive_dir / "temp" / try_filename
  4994. retry_temp_path.parent.mkdir(parents=True, exist_ok=True)
  4995. for remote_path in (
  4996. f"/{try_filename}",
  4997. f"/cache/{try_filename}",
  4998. f"/model/{try_filename}",
  4999. f"/data/{try_filename}",
  5000. f"/data/Metadata/{try_filename}",
  5001. ):
  5002. try:
  5003. if ftp_retry_enabled:
  5004. downloaded = await with_ftp_retry(
  5005. download_file_async,
  5006. printer.ip_address,
  5007. printer.access_code,
  5008. remote_path,
  5009. retry_temp_path,
  5010. timeout=ftp_timeout,
  5011. socket_timeout=ftp_timeout,
  5012. printer_model=printer.model,
  5013. max_retries=ftp_retry_count,
  5014. retry_delay=ftp_retry_delay,
  5015. operation_name=f"Re-download 3MF from {remote_path}",
  5016. cooloff_ip=printer.ip_address,
  5017. non_retry_exceptions=(FileNotOnPrinterError,),
  5018. )
  5019. else:
  5020. downloaded = await download_file_async(
  5021. printer.ip_address,
  5022. printer.access_code,
  5023. remote_path,
  5024. retry_temp_path,
  5025. timeout=ftp_timeout,
  5026. socket_timeout=ftp_timeout,
  5027. printer_model=printer.model,
  5028. )
  5029. if downloaded and peek_plate_index_in_3mf(retry_temp_path) == expected_plate:
  5030. logger.info(
  5031. "[CALLBACK] Re-download succeeded with corrected name %s "
  5032. "(plate %s) — replacing wrong file",
  5033. try_filename,
  5034. expected_plate,
  5035. )
  5036. try:
  5037. temp_path.unlink(missing_ok=True)
  5038. except OSError:
  5039. pass
  5040. temp_path = retry_temp_path
  5041. downloaded_filename = try_filename
  5042. subtask_name = corrected_subtask
  5043. cache_3mf_download(printer_id, try_filename, temp_path)
  5044. retry_succeeded = True
  5045. break
  5046. elif downloaded:
  5047. # Wrong plate again — discard and keep trying
  5048. try:
  5049. retry_temp_path.unlink(missing_ok=True)
  5050. except OSError:
  5051. pass
  5052. except FileNotOnPrinterError:
  5053. continue
  5054. except Exception as e:
  5055. logger.debug("Re-download failed for %s: %s", remote_path, e)
  5056. if retry_succeeded:
  5057. break
  5058. # If the retry didn't find a matching file, drop the wrong 3MF
  5059. # so the no-3MF fallback below creates an archive whose name
  5060. # at least reflects the right plate.
  5061. if not retry_succeeded:
  5062. logger.warning(
  5063. "[CALLBACK] Could not re-download correct plate %s — falling back to no-3MF archive",
  5064. expected_plate,
  5065. )
  5066. try:
  5067. temp_path.unlink(missing_ok=True)
  5068. except OSError:
  5069. pass
  5070. temp_path = None
  5071. downloaded_filename = None
  5072. # Whatever the sweep's transport did earlier, it is not why
  5073. # this archive ends up empty: a 3MF downloaded fine, it was
  5074. # just the wrong plate. Retrying would re-fetch that same
  5075. # contradicted file under the same stale names and hand it
  5076. # to _recover_fallback_archive, which checks that a
  5077. # candidate is a readable 3MF but not which plate it is --
  5078. # so the row would be filled in with another plate's
  5079. # filament and cost, the exact swap #2957 removed (#3063).
  5080. ftp_transfer_failed = False
  5081. # Disown the name for *lookups*: it has just been shown to
  5082. # fetch another plate's 3MF, and it keys `_active_prints`
  5083. # below, where the cover endpoint's own download of that
  5084. # same name would find this archive and fill it in with the
  5085. # file we are discarding here.
  5086. #
  5087. # Keep it for the *title*, which is a separate question.
  5088. # ``swap_plate_suffix`` returns None both for a name that
  5089. # carries no "- Plate N" / "_plate_N" suffix and for no
  5090. # name at all, and those are not the same situation: a name
  5091. # without a suffix holds no stale plate number to be wrong
  5092. # about. Blanking both uses at once dropped the project
  5093. # name too, and the row fell through to the gcode_file path
  5094. # titled "plate_1" though the real name was in hand.
  5095. # #1204's own premise is consecutive plates *of the same
  5096. # model*, so the project part is right either way (#3126).
  5097. display_name_after_plate_reject = corrected_subtask or subtask_name or None
  5098. subtask_name = corrected_subtask or ""
  5099. # Deleted while the 3MF was being fetched (that can take minutes): no
  5100. # archive, timelapse or tracking for a printer that will never report
  5101. # the print's end. forget_printer again: the download registered its
  5102. # 3MF cache entry after the delete cleared the id. (A delete committing
  5103. # while the archive is written is caught after its commit.)
  5104. if await _printer_gone(db, printer_id):
  5105. logger.info("Printer %s was deleted during the print-start download; not archiving", printer_id)
  5106. await forget_printer(printer_id)
  5107. return
  5108. if not downloaded_filename or not temp_path:
  5109. logger.warning("Could not find 3MF file for print: %s", filename or subtask_name)
  5110. # Create a fallback archive without 3MF data so the print is still tracked
  5111. # This commonly happens with P1S/A1 printers where FTP has file size limitations
  5112. try:
  5113. from backend.app.models.archive import PrintArchive
  5114. # Why the card is empty. The two temporary causes outrank the
  5115. # storage verdict because they say the sweep never got a fair
  5116. # answer: a cool-off skipped it at the transport, and a failed
  5117. # transfer reached the printer but never finished. Either way
  5118. # the file is still on the card, so reporting where the printer
  5119. # files its jobs would describe a setting that is not the
  5120. # problem (#2957, #3063).
  5121. if blocked_by_ftps_cooloff:
  5122. no_3mf_reason = REASON_FTPS_COOLOFF
  5123. elif storage.reachable and ftp_transfer_failed:
  5124. no_3mf_reason = REASON_FTP_TRANSFER_FAILED
  5125. else:
  5126. no_3mf_reason = storage.reason
  5127. # Derive print name from subtask_name or filename. The
  5128. # plate guard's disowned name comes second: it is a real name
  5129. # for a real print, and only the gcode_file path is left
  5130. # otherwise -- which titles the row "plate_1" (#3126).
  5131. print_name = subtask_name or display_name_after_plate_reject or filename
  5132. if print_name:
  5133. # Clean up the name (remove extensions, path parts)
  5134. print_name = print_name.split("/")[-1]
  5135. print_name = print_name.replace(".gcode.3mf", "").replace(".gcode", "").replace(".3mf", "")
  5136. else:
  5137. print_name = "Unknown Print"
  5138. # Recover estimated print time from MQTT (best-effort for notifications)
  5139. fallback_print_time = None
  5140. mqtt_remaining = data.get("remaining_time")
  5141. if mqtt_remaining and isinstance(mqtt_remaining, (int, float)) and mqtt_remaining > 0:
  5142. fallback_print_time = int(mqtt_remaining)
  5143. if fallback_print_time is None:
  5144. mc_remaining = (data.get("raw_data") or {}).get("mc_remaining_time")
  5145. if mc_remaining and isinstance(mc_remaining, (int, float)) and mc_remaining > 0:
  5146. fallback_print_time = int(mc_remaining * 60)
  5147. # Best-effort filament metadata from MQTT — see
  5148. # _extract_filament_data_from_mqtt. Without this the fallback
  5149. # archive's filament fields stayed NULL even though the AMS
  5150. # state at print start was sitting right there in `data`.
  5151. # The slicer's ams_mapping (when present) narrows the result
  5152. # to slots actually used by the print (#1533).
  5153. mqtt_filament_meta = _extract_filament_data_from_mqtt(data, _get_start_ams_mapping(data, None))
  5154. # Create minimal archive entry
  5155. fallback_archive = PrintArchive(
  5156. printer_id=printer_id,
  5157. filename=filename or f"{print_name}.3mf",
  5158. file_path="", # Empty - no 3MF file available
  5159. file_size=0,
  5160. print_name=print_name,
  5161. print_time_seconds=fallback_print_time,
  5162. status="printing",
  5163. started_at=datetime.now(timezone.utc),
  5164. subtask_id=subtask_id,
  5165. confirm_requested=await _ask_outcome_for_external_print(db, printer_id, subtask_name),
  5166. filament_type=mqtt_filament_meta.get("filament_type"),
  5167. filament_color=mqtt_filament_meta.get("filament_color"),
  5168. extra_data={
  5169. "no_3mf_available": True,
  5170. # Why the card is empty, when we know -- see above. The
  5171. # banner reads this to stop telling H2/P2 owners to
  5172. # switch on a setting that is already on and would not
  5173. # have helped (#2780).
  5174. "no_3mf_reason": no_3mf_reason,
  5175. "original_subtask": subtask_name or display_name_after_plate_reject or "",
  5176. "_print_data": data,
  5177. },
  5178. )
  5179. db.add(fallback_archive)
  5180. try:
  5181. await db.commit()
  5182. except IntegrityError:
  5183. # Not "Failed to create fallback archive" below, and no
  5184. # start notification for a printer that is gone.
  5185. if await _refused_for_deleted_printer(db, printer_id, "its fallback archive was written"):
  5186. return
  5187. raise
  5188. await db.refresh(fallback_archive)
  5189. logger.info("Created fallback archive %s for %s (no 3MF available)", fallback_archive.id, print_name)
  5190. if await _drop_archive_of_deleted_printer(db, printer_id, fallback_archive.id):
  5191. return
  5192. _maybe_start_layer_timelapse(printer, printer_id, fallback_archive.id)
  5193. # Track as active print
  5194. _bind_active_print(printer_id, fallback_archive.id, fallback_archive.filename, filename, subtask_name)
  5195. # Record starting energy if smart plug available (#941: persisted column)
  5196. await _record_energy_start(fallback_archive, printer_id, db, context="fallback")
  5197. # Send WebSocket notification
  5198. await ws_manager.send_archive_created(
  5199. {
  5200. "id": fallback_archive.id,
  5201. "printer_id": fallback_archive.printer_id,
  5202. "filename": fallback_archive.filename,
  5203. "print_name": fallback_archive.print_name,
  5204. "status": fallback_archive.status,
  5205. }
  5206. )
  5207. # MQTT relay - publish archive created
  5208. try:
  5209. await mqtt_relay.on_archive_created(
  5210. archive_id=fallback_archive.id,
  5211. print_name=fallback_archive.print_name,
  5212. printer_name=printer.name,
  5213. status=fallback_archive.status,
  5214. )
  5215. except Exception:
  5216. pass # Don't fail if MQTT fails
  5217. # Store Spoolman tracking data (may not work for fallback since no 3MF)
  5218. try:
  5219. await _store_spoolman_print_data(
  5220. printer_id,
  5221. fallback_archive.id,
  5222. fallback_archive.file_path,
  5223. db,
  5224. printer_manager,
  5225. ams_mapping=_get_start_ams_mapping(data, fallback_archive.id),
  5226. plate_id=_get_start_plate_id(fallback_archive.id),
  5227. )
  5228. except Exception as e:
  5229. logger.debug("[SPOOLMAN] Could not store tracking for fallback archive: %s", e)
  5230. # Both temporary give-ups are worth coming back for, and for
  5231. # the same reason: the file is on the printer and the last look
  5232. # failed at the transport rather than finding nothing. One waits
  5233. # out the handshake block (#2957), the other waits for the
  5234. # printer to stop being busy (#3063). Deliberately not scheduled
  5235. # for a storage verdict: a file on internal eMMC will not appear
  5236. # at any FTPS path however long we wait, and retrying it is
  5237. # exactly the sweep #2780 removed.
  5238. if no_3mf_reason in (REASON_FTPS_COOLOFF, REASON_FTP_TRANSFER_FAILED) and possible_names:
  5239. # `possible_names`, not the raw MQTT strings: it is the exact
  5240. # list this flow just tried, already stripped of any path
  5241. # (`filename` arrives as "/data/Metadata/plate_1.gcode" on
  5242. # some firmware) and deduped.
  5243. _schedule_fallback_3mf_retry(
  5244. printer_id=printer_id,
  5245. archive_id=fallback_archive.id,
  5246. filenames=list(possible_names),
  5247. reason=no_3mf_reason,
  5248. )
  5249. # Send notification without archive data (file not found)
  5250. if not notification_sent:
  5251. await _send_print_start_notification(printer_id, data, logger=logger)
  5252. # The same baseline the other two on_print_start branches take
  5253. # (#2704), and last for the same reason they are: it lists the
  5254. # printer's timelapse directory, so a slow card must not delay
  5255. # the _active_prints registration, the energy reading, the
  5256. # archive-created event or the start notification above it.
  5257. #
  5258. # This branch never took one, so every no-3MF archive reached
  5259. # completion with no baseline in memory and none on the row, and
  5260. # the completion scan fell into its "snapshot now" fallback --
  5261. # which runs after the printer has written the video, so the new
  5262. # file landed inside the baseline and no diff ever matched
  5263. # (#2957 follow-up).
  5264. #
  5265. # Skipped when the FTPS cool-off is what produced this fallback:
  5266. # the listing needs the same connection that just failed, so it
  5267. # could only record that the card was unreadable. The scan
  5268. # handles that case by refusing to choose between candidates.
  5269. if not blocked_by_ftps_cooloff:
  5270. await _capture_timelapse_baseline_at_start(
  5271. printer, printer_id, logger, archive_id=fallback_archive.id
  5272. )
  5273. await _forget_if_printer_gone(printer_id)
  5274. return
  5275. except Exception as e:
  5276. logger.error("Failed to create fallback archive: %s", e)
  5277. # Send notification without archive data (file not found)
  5278. if not notification_sent:
  5279. await _send_print_start_notification(printer_id, data, logger=logger)
  5280. return
  5281. try:
  5282. # Archive the file with status "printing"
  5283. service = ArchiveService(db)
  5284. try:
  5285. archive = await service.archive_print(
  5286. printer_id=printer_id,
  5287. source_file=temp_path,
  5288. print_data={**data, "status": "printing"},
  5289. subtask_id=subtask_id,
  5290. )
  5291. except IntegrityError:
  5292. # archive_print removed the folder it had copied the 3MF into.
  5293. if await _refused_for_deleted_printer(db, printer_id, "its archive was written"):
  5294. return
  5295. raise
  5296. if archive:
  5297. # Ask-for-outcome for a print Bambuddy did not dispatch (#1898).
  5298. # Set on the row rather than passed to archive_print, which also
  5299. # serves the queue dispatcher — there the queue item decides.
  5300. # Guarded because this branch has no ``except``: an unhandled
  5301. # write error would take the _active_prints registration, the
  5302. # start notification, the energy reading and the timelapse
  5303. # baseline below it with it, and a missing prompt is by far the
  5304. # cheaper failure.
  5305. archive_id = archive.id
  5306. try:
  5307. if await _ask_outcome_for_external_print(db, printer_id, subtask_name):
  5308. archive.confirm_requested = True
  5309. await db.commit()
  5310. except Exception as e:
  5311. logger.warning("Could not flag archive %s for the outcome prompt: %s", archive_id, e)
  5312. # The rollback expires every loaded object, and on an async
  5313. # session reading one afterwards raises instead of
  5314. # reloading, so the two this branch goes on to use are
  5315. # fetched again. The archive itself was committed by
  5316. # archive_print; only the flag is lost.
  5317. try:
  5318. await db.rollback()
  5319. archive = await db.get(PrintArchive, archive_id)
  5320. printer = await db.get(Printer, printer_id)
  5321. except Exception as reload_error:
  5322. logger.warning(
  5323. "Could not reload archive %s after the failed flag write: %s", archive_id, reload_error
  5324. )
  5325. if await _drop_archive_of_deleted_printer(db, printer_id, archive_id):
  5326. return
  5327. # Track this active print (use both original filename and downloaded filename)
  5328. _bind_active_print(printer_id, archive_id, downloaded_filename, filename, subtask_name)
  5329. logger.info("Created archive %s for %s", archive.id, downloaded_filename)
  5330. _maybe_start_layer_timelapse(printer, printer_id, archive.id)
  5331. # Record starting energy from smart plug if available (#941: persisted column)
  5332. await _record_energy_start(archive, printer_id, db, context="auto-archive")
  5333. await ws_manager.send_archive_created(
  5334. {
  5335. "id": archive.id,
  5336. "printer_id": archive.printer_id,
  5337. "filename": archive.filename,
  5338. "print_name": archive.print_name,
  5339. "status": archive.status,
  5340. }
  5341. )
  5342. # MQTT relay - publish archive created
  5343. try:
  5344. await mqtt_relay.on_archive_created(
  5345. archive_id=archive.id,
  5346. print_name=archive.print_name,
  5347. printer_name=printer.name,
  5348. status=archive.status,
  5349. )
  5350. except Exception:
  5351. pass # Don't fail if MQTT fails
  5352. # Send notification with archive data (new archive created)
  5353. if not notification_sent:
  5354. archive_data = {
  5355. "print_time_seconds": archive.print_time_seconds,
  5356. "created_by_id": archive.created_by_id,
  5357. }
  5358. await _send_print_start_notification(printer_id, data, archive_data, logger)
  5359. # Extract printable objects for skip object functionality
  5360. try:
  5361. from backend.app.services.archive import extract_printable_objects_from_3mf
  5362. client = printer_manager.get_client(printer_id)
  5363. if client:
  5364. with open(temp_path, "rb") as f:
  5365. threemf_data = f.read()
  5366. # Extract with positions for UI overlay, scoped to the
  5367. # plate that is printing — an all-plates 3MF carries
  5368. # every plate's objects (#2522).
  5369. printable_objects, bbox_all = extract_printable_objects_from_3mf(
  5370. threemf_data,
  5371. plate_number=resolve_plate_id(client.state),
  5372. include_positions=True,
  5373. )
  5374. if printable_objects:
  5375. # Store objects in printer state
  5376. client.state.printable_objects = printable_objects
  5377. client.state.printable_objects_bbox_all = bbox_all
  5378. client.state.skipped_objects = [] # Reset skipped objects for new print
  5379. logger.info(
  5380. "Loaded %s printable objects for printer %s", len(printable_objects), printer_id
  5381. )
  5382. except Exception as e:
  5383. logger.debug("Failed to extract printable objects: %s", e)
  5384. # Store Spoolman tracking data for per-filament usage reporting
  5385. try:
  5386. await _store_spoolman_print_data(
  5387. printer_id,
  5388. archive.id,
  5389. archive.file_path,
  5390. db,
  5391. printer_manager,
  5392. ams_mapping=_get_start_ams_mapping(data, archive.id),
  5393. plate_id=_get_start_plate_id(archive.id),
  5394. )
  5395. except Exception as e:
  5396. logger.warning("[SPOOLMAN] Failed to store tracking data: %s", e)
  5397. # Price the print from its spools now rather than only at completion (#3261)
  5398. _schedule_archive_cost_estimate(
  5399. printer_id,
  5400. archive.id,
  5401. printer_manager,
  5402. ams_mapping=_get_start_ams_mapping(data, archive.id),
  5403. plate_id=_get_start_plate_id(archive.id),
  5404. session_factory=async_session,
  5405. )
  5406. # Capture timelapse file baseline for snapshot-diff on completion
  5407. await _capture_timelapse_baseline_at_start(printer, printer_id, logger, archive_id=archive.id)
  5408. await _forget_if_printer_gone(printer_id)
  5409. finally:
  5410. # Keep temp_path around until print completes so the cover endpoint
  5411. # can reuse it (#972). Cache eviction in on_print_complete deletes
  5412. # the file. If the cache entry was evicted early (file vanished),
  5413. # clean up any stragglers here to avoid leaking disk on retries.
  5414. cached_now = get_cached_3mf(printer_id, downloaded_filename) if downloaded_filename else None
  5415. if temp_path and temp_path.exists() and cached_now != temp_path:
  5416. temp_path.unlink()
  5417. _TIMELAPSE_VIDEO_EXTENSIONS = (".mp4", ".avi")
  5418. # Poll schedule for the post-print timelapse scan (#2704). Module-level so
  5419. # tests can shrink them without waiting out real delays.
  5420. #
  5421. # This replaced a fixed [5, 10, 20, 30] retry ladder, i.e. roughly 65 s of
  5422. # looking. Across 247 support bundles the attempt that found the video was #1
  5423. # 272 times, then 17 / 13 / 13 — a flat tail against the cutoff rather than a
  5424. # decaying one, which is the signature of a budget that expires while files are
  5425. # still arriving. 457 scans were scheduled and only 262 ever attached. Big
  5426. # prints make big videos and the printer writes them after the print ends, so
  5427. # the poll now runs for minutes and costs one FTP LIST per round.
  5428. _TIMELAPSE_SCAN_FIRST_DELAY_SECONDS: float = 5.0
  5429. _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS: float = 30.0
  5430. _TIMELAPSE_SCAN_TIMEOUT_SECONDS: float = 900.0
  5431. def _timelapse_scan_max_attempts() -> int:
  5432. """Round cap for the poll, derived from the wall-clock budget.
  5433. The deadline alone is not a sufficient bound: it assumes each round really
  5434. waits, which stops being true the moment ``asyncio.sleep`` is patched out,
  5435. and an FTP list that fails immediately would otherwise spin against the
  5436. printer at full speed for the whole window. Whichever bound is reached
  5437. first ends the poll.
  5438. """
  5439. if _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS <= 0:
  5440. # A zero interval makes the wall-clock budget meaningless; fall back to
  5441. # the round count the production interval would have given.
  5442. return 32
  5443. return max(1, int(_TIMELAPSE_SCAN_TIMEOUT_SECONDS // _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS) + 1)
  5444. async def _claimed_timelapse_names(db, printer_id: int, exclude_archive_id: int) -> set[str]:
  5445. """Video filenames already attached to some other archive of this printer.
  5446. Used to disambiguate when more than one file is new since the baseline —
  5447. which happens when a previous print's video landed after this print's
  5448. baseline was taken. Ordering the candidates would be the obvious fix and is
  5449. the wrong one: it can only be done on mtime or on the filename timestamp,
  5450. both of which come from the printer's own clock, and a LAN-only printer
  5451. can't reach Bambu's NTP server. Exclusion needs no clock at all.
  5452. ``attach_timelapse`` saves the video into the archive directory under the
  5453. printer's original filename, and the later MP4 conversion keeps the stem,
  5454. so the stem of ``timelapse_path`` recovers what was claimed.
  5455. """
  5456. from backend.app.models.archive import PrintArchive
  5457. rows = await db.execute(
  5458. select(PrintArchive.timelapse_path).where(
  5459. PrintArchive.printer_id == printer_id,
  5460. PrintArchive.id != exclude_archive_id,
  5461. PrintArchive.timelapse_path.is_not(None),
  5462. )
  5463. )
  5464. return {Path(p).stem for p in rows.scalars().all() if p}
  5465. def _timelapse_listing_is_trustworthy(printer) -> bool:
  5466. """Whether an *empty* timelapse listing for *printer* can be believed.
  5467. ``list_files_async`` answers ``[]`` when its connect fails rather than
  5468. raising, so a card behind the FTPS handshake cool-off is indistinguishable
  5469. from one holding no videos. Everywhere that only wants to know "is there a
  5470. video yet" the difference does not matter — both mean "not yet, retry".
  5471. It matters where an empty listing is recorded as a *baseline*. Recording
  5472. "the card held nothing" for a card that was never read means every video on
  5473. it counts as new once the cool-off expires, and the completion scan then
  5474. attaches a stale video to this print and deletes it from the printer
  5475. (#2957 follow-up). Those two callers ask this first.
  5476. """
  5477. from backend.app.services.bambu_ftp import ftps_handshake_blocked
  5478. ip_address = getattr(printer, "ip_address", None)
  5479. if not ip_address:
  5480. return True
  5481. return not ftps_handshake_blocked(ip_address)
  5482. async def _list_timelapse_videos(printer) -> tuple[list[dict], str | None]:
  5483. """List video files from printer's timelapse directory.
  5484. Finds MP4 (X1/A1 series) and AVI (P1 series) timelapse files.
  5485. Returns (video_files, found_path) where video_files is a list of file dicts
  5486. and found_path is the directory where they were found, or ([], None).
  5487. An empty return does not distinguish "no videos" from "could not read the
  5488. card" — see :func:`_timelapse_listing_is_trustworthy`, which the two
  5489. baseline callers consult before believing one.
  5490. """
  5491. from backend.app.services.bambu_ftp import list_files_async
  5492. logger = logging.getLogger(__name__)
  5493. # No card in the slot means no /timelapse to walk — four connections that
  5494. # can only fail, on a path whose failures are swallowed and so would go on
  5495. # costing time silently forever (#2780).
  5496. #
  5497. # ``getattr`` rather than ``printer.id``: every dereference below happens
  5498. # inside the loop's own try/except, so a caller that passed something
  5499. # unexpected used to get an empty listing rather than an exception. Keep
  5500. # that, instead of making this gate the first thing that can raise here.
  5501. printer_id = getattr(printer, "id", None)
  5502. if printer_id is not None and not external_storage_present(printer_manager.get_status(printer_id)):
  5503. logger.debug("[TIMELAPSE] Skipping the scan for printer %s: it reports no external storage", printer_id)
  5504. return [], None
  5505. for timelapse_path in ["/timelapse", "/timelapse/video", "/record", "/recording"]:
  5506. try:
  5507. found_files = await list_files_async(
  5508. printer.ip_address, printer.access_code, timelapse_path, printer_model=printer.model
  5509. )
  5510. if found_files:
  5511. video_files = [
  5512. f
  5513. for f in found_files
  5514. if not f.get("is_directory") and f.get("name", "").lower().endswith(_TIMELAPSE_VIDEO_EXTENSIONS)
  5515. ]
  5516. if video_files:
  5517. return video_files, timelapse_path
  5518. except Exception as e:
  5519. logger.debug("[TIMELAPSE] Path %s failed: %s", timelapse_path, e)
  5520. continue
  5521. return [], None
  5522. async def _capture_timelapse_baseline_at_start(
  5523. printer, printer_id: int, logger: logging.Logger, archive_id: int | None = None
  5524. ) -> None:
  5525. """Snapshot the printer's timelapse directory at print start so the
  5526. completion-time scan can pick the new file by set-difference.
  5527. Must be called from every on_print_start path that proceeds to a real
  5528. print — both the new-archive branch and the expected-archive branch (which
  5529. queue / VP-dispatched prints take). Without a baseline,
  5530. _scan_for_timelapse_with_retries falls into its "take baseline now"
  5531. fallback that runs AFTER the new MP4 has already landed on the SD card,
  5532. so the new file ends up in the "baseline" set and no diff ever matches.
  5533. Bambu printers in LAN-only mode don't sync NTP, so mtime ordering is
  5534. unreliable — the snapshot-diff approach sidesteps that entirely.
  5535. When ``archive_id`` is known the baseline is also written to the archive
  5536. row, so it survives a restart and the manual "Scan for Timelapse" button
  5537. can run the same diff instead of falling back to clock-based matching
  5538. (#2704). Only baselines taken at print start are persisted — one taken at
  5539. completion already contains the new video and would poison a later scan.
  5540. """
  5541. names: set[str] | None = None
  5542. try:
  5543. if not _timelapse_listing_is_trustworthy(printer):
  5544. # Recorded anyway, deliberately. An empty baseline taken off a card
  5545. # we could not read is not authoritative, but it is still the right
  5546. # *default*: Bambuddy deletes each video from the printer once it is
  5547. # attached, so the usual card holds exactly one video at completion
  5548. # and an empty baseline resolves it correctly. Persisting NULL
  5549. # instead would send completion to take its own snapshot, by which
  5550. # point this print's video is on the card and would be swallowed by
  5551. # it. The ambiguity is handled where it actually bites — see
  5552. # ``require_unambiguous`` in the scan (#2957 follow-up).
  5553. logger.warning(
  5554. "[TIMELAPSE] Baseline for printer %s taken while its file service is in the FTPS "
  5555. "handshake cool-off, so the card could not be read — treating it as empty",
  5556. printer_id,
  5557. )
  5558. baseline_files, _ = await _list_timelapse_videos(printer)
  5559. names = {f.get("name", "") for f in baseline_files}
  5560. _timelapse_baselines[printer_id] = names
  5561. logger.info(
  5562. "[TIMELAPSE] Baseline at print start: %s video files for printer %s",
  5563. len(names),
  5564. printer_id,
  5565. )
  5566. except Exception as e:
  5567. logger.warning("[TIMELAPSE] Failed to capture baseline at print start: %s", e)
  5568. if archive_id is None:
  5569. return
  5570. try:
  5571. async with async_session() as db:
  5572. from backend.app.models.archive import PrintArchive
  5573. archive = await db.get(PrintArchive, archive_id)
  5574. if archive is not None:
  5575. # Written even when the listing failed, and then as NULL. A
  5576. # reprint reuses the archive row, so leaving the previous run's
  5577. # baseline in place would have the scan diff this print against
  5578. # the state of the printer before the *last* one — and a stale
  5579. # baseline reads as authoritative, where NULL correctly falls
  5580. # back to a fresh snapshot.
  5581. archive.timelapse_baseline = sorted(names) if names is not None else None
  5582. await db.commit()
  5583. except Exception as e:
  5584. # In-memory baseline still covers the normal completion path.
  5585. logger.warning("[TIMELAPSE] Failed to persist baseline for archive %s: %s", archive_id, e)
  5586. async def _scan_for_timelapse_with_retries(
  5587. archive_id: int, baseline_names: set[str] | None = None, *, plate_id: int | None = None
  5588. ):
  5589. """Poll the printer for this print's timelapse and attach it.
  5590. Snapshot diff, not timestamp matching: a printer in LAN-only mode cannot
  5591. reach Bambu's NTP server, so the clock behind both the filename and the FTP
  5592. mtime is arbitrarily wrong — one reporter's P1S was six and a half days out
  5593. (#2704). Comparing the current listing against the set of filenames that
  5594. existed when the print started needs no clock at all, because the printer
  5595. writes the video only once the print has ended.
  5596. Baseline precedence: the caller's in-memory set, then the one persisted on
  5597. the archive at print start, then a snapshot taken now. The last of those is
  5598. a poor substitute — by completion the new video may already be on the card,
  5599. in which case it lands in the "baseline" and no diff can ever match — but it
  5600. is all that is available for a print that began before Bambuddy started.
  5601. On success the video is deleted from the printer, which keeps ``/timelapse``
  5602. down to the unclaimed files and makes the next diff unambiguous.
  5603. """
  5604. logger = logging.getLogger(__name__)
  5605. # Cleared when the baseline had to be taken off a card we could not read, so
  5606. # the attach step refuses to choose between several candidates (#2957).
  5607. baseline_trusted = True
  5608. # --- Phase 1: establish the baseline -------------------------------------
  5609. try:
  5610. async with async_session() as db:
  5611. from backend.app.models.printer import Printer
  5612. service = ArchiveService(db)
  5613. archive = await service.get_archive(archive_id)
  5614. if not archive:
  5615. logger.warning("[TIMELAPSE] Archive %s not found, aborting", archive_id)
  5616. return
  5617. if archive.timelapse_path:
  5618. logger.info("[TIMELAPSE] Archive %s already has timelapse attached", archive_id)
  5619. return
  5620. if not archive.printer_id:
  5621. logger.warning("[TIMELAPSE] Archive %s has no printer, aborting", archive_id)
  5622. return
  5623. if baseline_names is not None:
  5624. logger.info(
  5625. "[TIMELAPSE] Using print-start baseline: %s existing video files for archive %s",
  5626. len(baseline_names),
  5627. archive_id,
  5628. )
  5629. elif archive.timelapse_baseline is not None:
  5630. # Persisted at print start — survives a restart mid-print.
  5631. baseline_names = set(archive.timelapse_baseline)
  5632. logger.info(
  5633. "[TIMELAPSE] Using stored baseline: %s existing video files for archive %s",
  5634. len(baseline_names),
  5635. archive_id,
  5636. )
  5637. else:
  5638. result = await db.execute(select(Printer).where(Printer.id == archive.printer_id))
  5639. printer = result.scalar_one_or_none()
  5640. if not printer:
  5641. logger.warning("[TIMELAPSE] Printer not found for archive %s, aborting", archive_id)
  5642. return
  5643. if not _timelapse_listing_is_trustworthy(printer):
  5644. # The card is unreadable at the one moment a baseline has to
  5645. # be taken, so the empty listing below means "we never
  5646. # looked", not "these are all new". Carry on with it anyway
  5647. # — the usual card holds exactly one video, which resolves
  5648. # correctly — but stop the poll from *choosing* between
  5649. # several, which is how a stale video got attached to this
  5650. # print and then deleted off the printer (#2957 follow-up).
  5651. baseline_trusted = False
  5652. logger.warning(
  5653. "[TIMELAPSE] Baseline for archive %s taken while printer %s is in the FTPS "
  5654. "handshake cool-off. A single new video still resolves; several will not be "
  5655. "guessed between — use Scan for Timelapse to pick one by hand",
  5656. archive_id,
  5657. archive.printer_id,
  5658. )
  5659. baseline_files, _ = await _list_timelapse_videos(printer)
  5660. baseline_names = {f.get("name", "") for f in baseline_files}
  5661. logger.info(
  5662. "[TIMELAPSE] Baseline snapshot (fallback): %s existing video files for archive %s",
  5663. len(baseline_names),
  5664. archive_id,
  5665. )
  5666. except Exception as e:
  5667. logger.warning("[TIMELAPSE] Failed to take baseline snapshot for archive %s: %s", archive_id, e)
  5668. return
  5669. # --- Phase 2: poll for a file that was not there when the print began -----
  5670. deadline = time.monotonic() + _TIMELAPSE_SCAN_TIMEOUT_SECONDS
  5671. max_attempts = _timelapse_scan_max_attempts()
  5672. seen_names: set[str] = set()
  5673. delay = _TIMELAPSE_SCAN_FIRST_DELAY_SECONDS
  5674. attempt = 0
  5675. while True:
  5676. await asyncio.sleep(delay)
  5677. delay = _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS
  5678. attempt += 1
  5679. try:
  5680. from backend.app.models.printer import Printer
  5681. # Read phase: fetch archive + printer in a short session and release
  5682. # the pooled connection BEFORE the FTP list/download below. Holding it
  5683. # across the FTP round-trips left one connection idle-in-transaction per
  5684. # in-flight scan (issue #2572).
  5685. async with async_session() as db:
  5686. service = ArchiveService(db)
  5687. archive = await service.get_archive(archive_id)
  5688. if not archive:
  5689. logger.warning("[TIMELAPSE] Archive %s not found, stopping poll", archive_id)
  5690. return
  5691. if archive.timelapse_path:
  5692. logger.info("[TIMELAPSE] Archive %s already has timelapse attached, stopping poll", archive_id)
  5693. return
  5694. result = await db.execute(select(Printer).where(Printer.id == archive.printer_id))
  5695. printer = result.scalar_one_or_none()
  5696. if not printer:
  5697. logger.warning("[TIMELAPSE] Printer not found for archive %s, stopping poll", archive_id)
  5698. return
  5699. claimed = await _claimed_timelapse_names(db, archive.printer_id, archive_id)
  5700. # I/O phase (no DB connection held): FTP list + download.
  5701. video_files, found_path = await _list_timelapse_videos(printer)
  5702. # The poll can run for dozens of rounds, so only narrate a round
  5703. # that saw something change. Repeating the whole listing every 30 s
  5704. # would bury the one interesting line in the support bundle.
  5705. names_now = {f.get("name", "") for f in video_files}
  5706. changed = attempt == 1 or names_now != seen_names
  5707. seen_names = names_now
  5708. speak = logger.info if changed else logger.debug
  5709. if video_files:
  5710. speak("[TIMELAPSE] Attempt %s: Found %s video files in %s", attempt, len(video_files), found_path)
  5711. if changed:
  5712. for f in video_files[:5]:
  5713. logger.info("[TIMELAPSE] - %s", f.get("name"))
  5714. attached = await _attach_first_unclaimed_timelapse(
  5715. archive_id,
  5716. printer,
  5717. video_files,
  5718. baseline_names,
  5719. claimed,
  5720. attempt,
  5721. logger,
  5722. quiet=not changed,
  5723. require_unambiguous=not baseline_trusted,
  5724. plate_id=plate_id,
  5725. )
  5726. if attached:
  5727. return
  5728. else:
  5729. speak("[TIMELAPSE] Attempt %s: No video files found, will retry", attempt)
  5730. except Exception as e:
  5731. logger.warning("[TIMELAPSE] Attempt %s failed with error: %s", attempt, e)
  5732. if attempt >= max_attempts or time.monotonic() >= deadline:
  5733. break
  5734. # No name-match fallback: it compared the print name against the filename,
  5735. # and Bambu firmware only ever writes "video_<timestamp>". Across 247 support
  5736. # bundles it fired 159 times and matched zero times, so all it added was a
  5737. # misleading log line before giving up.
  5738. logger.warning(
  5739. "[TIMELAPSE] No new video appeared for archive %s within %ss, giving up",
  5740. archive_id,
  5741. int(_TIMELAPSE_SCAN_TIMEOUT_SECONDS),
  5742. )
  5743. async def _attach_first_unclaimed_timelapse(
  5744. archive_id: int,
  5745. printer,
  5746. video_files: list[dict],
  5747. baseline_names: set[str],
  5748. claimed: set[str],
  5749. attempt: int,
  5750. logger: logging.Logger,
  5751. *,
  5752. quiet: bool = False,
  5753. require_unambiguous: bool = False,
  5754. plate_id: int | None = None,
  5755. ) -> bool:
  5756. """Download and attach the one video that belongs to this print.
  5757. A candidate is any file absent from the print-start baseline. More than one
  5758. can qualify when a previous print's video landed late, after this print's
  5759. baseline was taken — those are filtered out by name, because they are
  5760. already attached to another archive. Sorting the candidates instead would
  5761. mean sorting on mtime or on the filename timestamp, both of which come from
  5762. the printer's unsynced clock.
  5763. Returns True once a video is attached. The printer's copy is deleted only
  5764. after the attach succeeds on bytes whose length matched the listing.
  5765. ``quiet`` downgrades the "nothing yet" lines to DEBUG when the caller has
  5766. already seen this exact listing — the poll runs for many rounds and only the
  5767. rounds where something changed are worth an INFO line.
  5768. """
  5769. from backend.app.services.bambu_ftp import (
  5770. DownloadDeadlineExceeded,
  5771. delete_archived_timelapse,
  5772. download_file_bytes_async,
  5773. remote_file_settled,
  5774. )
  5775. speak = logger.debug if quiet else logger.info
  5776. new_files = [f for f in video_files if f.get("name", "") not in baseline_names]
  5777. if not new_files:
  5778. speak("[TIMELAPSE] Attempt %s: No new files since baseline, will retry", attempt)
  5779. return False
  5780. candidates = [f for f in new_files if Path(f.get("name", "")).stem not in claimed]
  5781. if not candidates:
  5782. speak(
  5783. "[TIMELAPSE] Attempt %s: %s new file(s), all already attached to other archives, will retry",
  5784. attempt,
  5785. len(new_files),
  5786. )
  5787. return False
  5788. if len(candidates) > 1:
  5789. if require_unambiguous:
  5790. # The baseline is not evidence -- it was taken off a card that could
  5791. # not be read -- so "new since the baseline" does not narrow these
  5792. # down at all. Taking the first would attach an arbitrary video to
  5793. # this print and then delete it from the printer.
  5794. logger.warning(
  5795. "[TIMELAPSE] Attempt %s: %s unclaimed videos (%s) and no baseline to tell them apart — "
  5796. "leaving all of them on the printer for manual selection",
  5797. attempt,
  5798. len(candidates),
  5799. ", ".join(str(f.get("name")) for f in candidates),
  5800. )
  5801. return False
  5802. logger.warning(
  5803. "[TIMELAPSE] Attempt %s: %s unclaimed new files (%s) — taking the first; "
  5804. "the rest stay on the printer for manual selection",
  5805. attempt,
  5806. len(candidates),
  5807. ", ".join(str(f.get("name")) for f in candidates),
  5808. )
  5809. target = candidates[0]
  5810. file_name = target.get("name")
  5811. remote_path = target.get("path") or f"/timelapse/{file_name}"
  5812. logger.info(
  5813. "[TIMELAPSE] Attempt %s: New file detected: %s (downloading for archive %s)",
  5814. attempt,
  5815. file_name,
  5816. archive_id,
  5817. )
  5818. # The listing always carries a size (`list_files` skips entries it can't
  5819. # parse), but read it explicitly: the delete below is destructive and must
  5820. # depend on a size we actually had, not on one we hoped was there.
  5821. expected_size = target.get("size")
  5822. try:
  5823. timelapse_data = await download_file_bytes_async(
  5824. printer.ip_address,
  5825. printer.access_code,
  5826. remote_path,
  5827. printer_model=printer.model,
  5828. expected_size=expected_size,
  5829. )
  5830. except DownloadDeadlineExceeded:
  5831. # Too slow for its size this round; the printer keeps its copy.
  5832. timelapse_data = None
  5833. if not timelapse_data:
  5834. # Short or failed transfer. The printer keeps its copy, so the next
  5835. # round can try again — which is exactly why the delete below is
  5836. # gated on a verified download.
  5837. logger.warning("[TIMELAPSE] Attempt %s: Failed to download new file, will retry", attempt)
  5838. return False
  5839. # The length check above proves we got what the listing said, not that the
  5840. # printer had finished writing. A video still being written can be listed
  5841. # short, served short, and pass — so confirm it has stopped growing before
  5842. # committing to it and deleting the original (#2704).
  5843. if not await remote_file_settled(
  5844. printer.ip_address,
  5845. printer.access_code,
  5846. remote_path,
  5847. len(timelapse_data),
  5848. printer_model=printer.model,
  5849. ):
  5850. return False
  5851. # Write phase: attach in a fresh short-lived session.
  5852. async with async_session() as db:
  5853. success = await ArchiveService(db).attach_timelapse(archive_id, timelapse_data, file_name, plate_id=plate_id)
  5854. if not success:
  5855. logger.warning("[TIMELAPSE] Failed to attach timelapse to archive %s", archive_id)
  5856. return False
  5857. logger.info("[TIMELAPSE] Successfully attached timelapse to archive %s", archive_id)
  5858. await ws_manager.send_archive_updated({"id": archive_id, "timelapse_attached": True})
  5859. await delete_archived_timelapse(
  5860. printer.ip_address,
  5861. printer.access_code,
  5862. remote_path,
  5863. verified=expected_size is not None,
  5864. printer_model=printer.model,
  5865. printer_name=printer.name,
  5866. )
  5867. return True
  5868. # Defaults for the finish-photo-from-timelapse polling loop (#1397). These are
  5869. # module-level so tests can monkeypatch them down to ~0 without timing out.
  5870. _FINISH_PHOTO_TIMELAPSE_POLL_INTERVAL_SECONDS: float = 3.0
  5871. _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS: float = 60.0
  5872. # How long the *background* upgrade keeps waiting after the notification has
  5873. # already gone out (#2704 follow-up). The short bound above exists so a slow
  5874. # printer can't hold up the print-complete notification; this one exists so the
  5875. # archive still ends up with the better frame afterwards.
  5876. #
  5877. # Measured across 261 attaches in the support bundles, the video lands a median
  5878. # 13s after the print ends — but the P1 series writes MJPEG AVI rather than
  5879. # H.264 MP4 and serves it slowly, so its p90 is 167s and the worst observed case
  5880. # was 546s. Every other model was inside 26s. The long budget is therefore
  5881. # almost entirely for P1-series users; on everything else the short wait already
  5882. # wins and this task never runs.
  5883. _FINISH_PHOTO_UPGRADE_TIMEOUT_SECONDS: float = 900.0
  5884. async def _capture_finish_photo_from_timelapse(
  5885. archive_id: int,
  5886. archive_dir: Path,
  5887. timeout: float | None = None,
  5888. rotation: int = 0,
  5889. ) -> tuple[str | None, bool]:
  5890. """Wait for the per-print timelapse to land on the archive and extract its
  5891. last frame as the finish photo (#1397).
  5892. Bambu firmware stops timelapse recording after the toolhead parks but
  5893. before the bed-drop end-gcode runs, so the last frame frames the finished
  5894. print correctly. A live camera grab at gcode_state=FINISH captures the
  5895. bed already lowered.
  5896. ``_scan_for_timelapse_with_retries`` runs in parallel and writes
  5897. ``archive.timelapse_path`` when the file lands. This function polls for
  5898. that field.
  5899. Returns ``(filename, still_pending)``. ``still_pending`` is True only when
  5900. the wait ran out with no video on the archive yet — i.e. the video may
  5901. still be coming and a later attempt could succeed. It is False when the
  5902. video landed (whether or not extraction worked), because in that case
  5903. waiting longer changes nothing. The caller uses that to decide between
  5904. falling back permanently and scheduling a background upgrade.
  5905. ``rotation`` is the printer's camera_rotation, applied to the extracted
  5906. still (#2708) so this source agrees with every other finish-photo source.
  5907. The archived video itself is the printer's own file and is left alone —
  5908. rotating it would mean re-encoding it.
  5909. """
  5910. import uuid
  5911. from backend.app.models.archive import PrintArchive
  5912. from backend.app.services.camera import apply_camera_rotation_to_file, extract_video_last_frame
  5913. logger = logging.getLogger(__name__)
  5914. budget = _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS if timeout is None else timeout
  5915. deadline = asyncio.get_event_loop().time() + budget
  5916. poll_interval = _FINISH_PHOTO_TIMELAPSE_POLL_INTERVAL_SECONDS
  5917. while True:
  5918. async with async_session() as db:
  5919. result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  5920. archive = result.scalar_one_or_none()
  5921. timelapse_relpath = archive.timelapse_path if archive else None
  5922. if timelapse_relpath:
  5923. video_path = app_settings.base_dir / timelapse_relpath
  5924. if video_path.exists() and video_path.stat().st_size > 0:
  5925. photos_dir = archive_dir / "photos"
  5926. photos_dir.mkdir(parents=True, exist_ok=True)
  5927. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  5928. filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  5929. output_path = photos_dir / filename
  5930. if await extract_video_last_frame(video_path, output_path):
  5931. await apply_camera_rotation_to_file(output_path, rotation, logger)
  5932. logger.info(
  5933. "[PHOTO-BG] Extracted finish photo from timelapse %s for archive %s",
  5934. video_path.name,
  5935. archive_id,
  5936. )
  5937. return filename, False
  5938. logger.warning(
  5939. "[PHOTO-BG] Timelapse %s landed but last-frame extraction failed for archive %s; falling back",
  5940. video_path.name,
  5941. archive_id,
  5942. )
  5943. return None, False
  5944. if asyncio.get_event_loop().time() >= deadline:
  5945. logger.info(
  5946. "[PHOTO-BG] Timelapse for archive %s didn't land within %.0fs; falling back to live camera",
  5947. archive_id,
  5948. budget,
  5949. )
  5950. return None, True
  5951. await asyncio.sleep(poll_interval)
  5952. async def _upgrade_finish_photo_from_timelapse(archive_id: int, archive_dir: Path, rotation: int = 0) -> None:
  5953. """Add the timelapse's last frame to an archive after the fact (#2704).
  5954. The print-complete notification waits only ~60s for the video, because
  5955. holding a notification for minutes is worse than sending it with a live
  5956. camera grab. On a P1-series printer the video often lands well after that,
  5957. so the archive used to be stuck with the live grab — which is taken at
  5958. ``gcode_state=FINISH``, after the end G-code has dropped the bed, and is
  5959. the worse photo of the two.
  5960. This keeps waiting in the background and, when the video arrives, extracts
  5961. the frame and puts it *first* in the archive's photo list, so opening the
  5962. gallery shows it. The live grab is deliberately kept: the notification that
  5963. already went out links to that exact file, and deleting it would leave a
  5964. broken image in Discord or Telegram.
  5965. """
  5966. logger = logging.getLogger(__name__)
  5967. filename, _ = await _capture_finish_photo_from_timelapse(
  5968. archive_id, archive_dir, timeout=_FINISH_PHOTO_UPGRADE_TIMEOUT_SECONDS, rotation=rotation
  5969. )
  5970. if not filename:
  5971. logger.info("[PHOTO-UPGRADE] No timelapse frame for archive %s; keeping the live grab", archive_id)
  5972. return
  5973. try:
  5974. async with async_session() as db:
  5975. from backend.app.models.archive import PrintArchive
  5976. archive = await db.get(PrintArchive, archive_id)
  5977. if archive is None:
  5978. return
  5979. photos = list(archive.photos or [])
  5980. if filename in photos:
  5981. return
  5982. # Front of the list: PhotoGalleryModal opens at index 0.
  5983. archive.photos = [filename, *photos]
  5984. await db.commit()
  5985. except Exception as e:
  5986. logger.warning("[PHOTO-UPGRADE] Failed to attach upgraded photo to archive %s: %s", archive_id, e)
  5987. return
  5988. logger.info("[PHOTO-UPGRADE] Archive %s now leads with the timelapse frame %s", archive_id, filename)
  5989. await ws_manager.send_archive_updated({"id": archive_id, "photo_added": filename})
  5990. async def _restore_usage_tracking_session(printer_id: int, state, db, logger) -> None:
  5991. """Put the filament-attribution context back after a restart mid-print.
  5992. ``usage_tracker._active_sessions`` and ``PrinterState.tray_change_log``
  5993. both die with the process. The print keeps running, so at completion the
  5994. tracker would fall back to whatever the printer reports *now* — and AMS
  5995. filament backup makes "now" the substitute tray, charging the whole print
  5996. to the spool that only finished it.
  5997. The persisted row is only trusted when its print name still matches what
  5998. the printer says it is running: a row left behind by a completion we never
  5999. saw must not attach itself to the next print.
  6000. """
  6001. try:
  6002. from backend.app.api.routes.settings import get_setting
  6003. from backend.app.services.usage_tracker import (
  6004. clear_persisted_session,
  6005. get_persisted_print_name,
  6006. restore_session,
  6007. )
  6008. persisted_name = await get_persisted_print_name(db, printer_id)
  6009. current_name = (state.subtask_name or "").strip()
  6010. if persisted_name and current_name and persisted_name.strip() != current_name:
  6011. logger.info(
  6012. "[RESTART] Discarding stale print session for printer %s (%r != running %r)",
  6013. printer_id,
  6014. persisted_name,
  6015. current_name,
  6016. )
  6017. await clear_persisted_session(db, printer_id)
  6018. # Fall through to seeding: the print on the printer is real, it just
  6019. # isn't the one the row described.
  6020. persisted_log = None
  6021. else:
  6022. # Spoolman users get the tray-change log back but no in-memory
  6023. # session — see ``on_print_start`` on why that dict is load-bearing
  6024. # for the remain%-sync guard.
  6025. _spoolman_on = await get_setting(db, "spoolman_enabled")
  6026. persisted_log = await restore_session(
  6027. db,
  6028. printer_id,
  6029. register_active=not (bool(_spoolman_on) and _spoolman_on.lower() == "true"),
  6030. )
  6031. if persisted_log:
  6032. restored = [tuple(entry) for entry in persisted_log if isinstance(entry, (list, tuple)) and len(entry) == 2]
  6033. # Anything this process already observed goes after the persisted
  6034. # history — the log is ordered by layer, and a fresh process can
  6035. # only have seen changes from later in the print.
  6036. for entry in state.tray_change_log or []:
  6037. if tuple(entry) not in restored:
  6038. restored.append(tuple(entry))
  6039. state.tray_change_log = restored
  6040. tray_now = state.tray_now
  6041. if 0 <= tray_now <= 254:
  6042. if not state.tray_change_log:
  6043. # No persisted history — a print that started before this build,
  6044. # or before the row existed. Seed with the tray feeding right
  6045. # now so the remainder of the print is at least attributable to
  6046. # the right spool.
  6047. state.tray_change_log = [(tray_now, state.layer_num)]
  6048. logger.info(
  6049. "[RESTART] Seeded tray change log for printer %s: tray=%d at layer=%d",
  6050. printer_id,
  6051. tray_now,
  6052. state.layer_num,
  6053. )
  6054. # The tray handler updates ``last_loaded_tray`` on every push
  6055. # regardless of whether it logged a change, so re-align it to avoid
  6056. # a duplicate entry on the next push. Only ever with a real tray:
  6057. # ``last_loaded_tray`` is the "survives the end-of-print retract to
  6058. # 255" fallback, and writing 255 into it would defeat that.
  6059. state.last_loaded_tray = tray_now
  6060. except Exception:
  6061. # Never let attribution recovery cost the caller its timelapse
  6062. # baseline — that capture has to happen before the printer uploads
  6063. # the in-flight MP4 and there is no second chance at it.
  6064. logger.exception("[RESTART] Failed to restore usage-tracking session for printer %s", printer_id)
  6065. async def on_print_running_observed(printer_id: int, data: dict):
  6066. """Restart-recovery for a print that started before Bambuddy came up.
  6067. bambu_mqtt.py suppresses ``on_print_start`` on the first RUNNING push
  6068. after Bambuddy startup (#1304 guard, prevents duplicate archive
  6069. creation). This hook restores the persisted archive into ``_active_prints``
  6070. and captures the timelapse baseline that normally hangs off print start.
  6071. Fires once per session, in lieu of on_print_start when restart-recovery
  6072. kicks in. The printer doesn't upload the timelapse until after PRINT
  6073. COMPLETE, so a baseline captured any time during the print is still
  6074. pre-upload.
  6075. """
  6076. logger = logging.getLogger(__name__)
  6077. async with async_session() as db:
  6078. from backend.app.models.printer import Printer
  6079. state = printer_manager.get_status(printer_id)
  6080. if state is not None:
  6081. authorization = await _is_bambuddy_authorized_print(printer_id, state, db)
  6082. if authorization is True:
  6083. logger.info("[RESTART] Restored active Bambuddy print for printer %s", printer_id)
  6084. await _restore_usage_tracking_session(printer_id, state, db, logger)
  6085. await _restore_printable_objects(printer_id, state, db, logger)
  6086. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  6087. printer = result.scalar_one_or_none()
  6088. if not printer:
  6089. logger.warning(
  6090. "[TIMELAPSE] on_print_running_observed: printer %s not found in DB, skipping baseline",
  6091. printer_id,
  6092. )
  6093. return
  6094. # Avoid double-capture: ownership reconciliation above must still run when
  6095. # a baseline already exists, but the camera work itself is one-shot.
  6096. if printer_id in _timelapse_baselines:
  6097. logger.debug(
  6098. "[TIMELAPSE] on_print_running_observed: baseline already present for printer %s, skipping",
  6099. printer_id,
  6100. )
  6101. return
  6102. await _capture_timelapse_baseline_at_start(printer, printer_id, logger)
  6103. def _is_active_archive_stale(archive, state) -> tuple[bool, str]:
  6104. """Return ``(is_stale, reason)`` for an archive in ``status="printing"``
  6105. against the printer's current MQTT state.
  6106. Reconciliation triggers (#1542 follow-up — recovers from missed PRINT
  6107. COMPLETE events, typically a print finishing during an MQTT disconnect
  6108. window followed by a smart-plug power cycle):
  6109. 1. Printer state is terminal (IDLE / FINISH / FAILED). The print is
  6110. provably not running anymore — only branch that should fire under
  6111. normal disconnect-then-reconnect timing.
  6112. 2. Printer has a different ``subtask_id`` than the archive. Bambu
  6113. firmware mints a fresh ``subtask_id`` for each print, including the
  6114. ghost replay it runs after a power cycle from a leftover SD file —
  6115. so a mismatch unambiguously means the in-DB archive is no longer
  6116. the print on the printer.
  6117. 3. Printer is running but ``subtask_name`` is empty. The printer
  6118. doesn't know what it's running; the archive's reference to it is
  6119. already broken.
  6120. Conservative on purpose: PAUSE / PREPARE / SLICING and any RUNNING state
  6121. with matching subtask_id+subtask_name is left alone. The cost of a false
  6122. positive is a duplicate archive on the next real PRINT COMPLETE — the
  6123. reactive handler uses ``_active_prints`` for lookup, which the reconcile
  6124. clears on synthesis, so the real completion creates a fresh row instead
  6125. of overwriting the synthesised one (#1679). The cost of a false negative
  6126. is the ghost-print loop in #1542.
  6127. Pre-push guard (#1679): when ``state.state`` is empty or ``"unknown"``,
  6128. MQTT has connected but the first ``push_status`` response hasn't been
  6129. applied yet — ``PrinterState`` is sitting on its construction defaults.
  6130. The reconcile caller in ``on_printer_status_change`` is already gated
  6131. on a real ``state.state``, so in normal operation this branch is
  6132. unreachable; it's kept as belt-and-braces for future callers and for
  6133. the narrow window where a partial state update could arrive
  6134. (``state.state`` set but ``subtask_name`` not yet populated). Returning
  6135. ``not stale`` on degenerate input is strictly conservative: a real
  6136. stale archive will still be caught by the next push_status arriving
  6137. with terminal state.
  6138. """
  6139. current_state = (state.state or "").upper()
  6140. if current_state in ("", "UNKNOWN"):
  6141. # No real push_status yet — PrinterState defaults are not evidence.
  6142. return False, ""
  6143. if current_state in ("IDLE", "FINISH", "FAILED"):
  6144. return True, f"printer state {current_state}"
  6145. # Below here the printer is in a running / pre-running state (RUNNING /
  6146. # PAUSE / PREPARE / SLICING / etc.) — decide based on subtask identity.
  6147. current_subtask_id = (state.subtask_id or "").strip()
  6148. if archive.subtask_id and current_subtask_id and archive.subtask_id != current_subtask_id:
  6149. return True, f"subtask_id changed ({archive.subtask_id!r} → {current_subtask_id!r})"
  6150. current_subtask_name = (state.subtask_name or "").strip()
  6151. if not current_subtask_name:
  6152. return True, "printer subtask_name empty"
  6153. return False, ""
  6154. async def prime_kprofile_table(printer_id: int) -> int:
  6155. """Read the printer's calibration table once per connection.
  6156. The AMS slot card shows a K value per slot (#2854). On the printers whose
  6157. trays carry no ``k`` field of their own -- the whole H2 series, whose trays
  6158. report ``cali_idx`` and nothing else -- that number can only come from
  6159. ``state.kprofiles``, and nothing used to fill it on connect. It arrived by
  6160. luck: someone opening the Profiles page or Configure Slot, a nightly GitHub
  6161. backup, or the printer answering a query BambuStudio made on the report
  6162. topic we share. A Bambuddy that nobody visited showed a card with no K
  6163. values at all.
  6164. Only the diameters actually fitted are asked for, which is one request on a
  6165. single-nozzle printer and two on a dual. Probing the four sizes blind is
  6166. what the backup does, and it is both wasteful and the thing that used to
  6167. blank the table.
  6168. Returns the number of nozzles whose table was read.
  6169. """
  6170. client = printer_manager.get_client(printer_id)
  6171. state = printer_manager.get_status(printer_id)
  6172. if client is None or state is None or not state.connected:
  6173. return 0
  6174. # Deduplicated, order preserved: a dual-nozzle printer with two 0.4s should
  6175. # ask once, and both entries are empty until the first push_status lands.
  6176. diameters = list(dict.fromkeys(n.nozzle_diameter for n in (state.nozzles or []) if n.nozzle_diameter))
  6177. if not diameters:
  6178. logging.getLogger(__name__).debug(
  6179. "[Printer %s] No nozzle diameter reported yet; leaving the K-profile table to the next reader",
  6180. printer_id,
  6181. )
  6182. return 0
  6183. primed = 0
  6184. for diameter in diameters:
  6185. try:
  6186. profiles = await client.get_kprofiles(nozzle_diameter=diameter, max_retries=2)
  6187. except Exception as exc: # noqa: BLE001
  6188. # A printer that won't answer costs the card its K values, nothing
  6189. # more — never the connection this runs on the back of.
  6190. logging.getLogger(__name__).warning(
  6191. "[Printer %s] Could not read the K-profile table for nozzle %s: %s", printer_id, diameter, exc
  6192. )
  6193. continue
  6194. primed += 1
  6195. logging.getLogger(__name__).info(
  6196. "[Printer %s] Primed K-profile table for nozzle %s: %d profiles", printer_id, diameter, len(profiles)
  6197. )
  6198. return primed
  6199. def _sd_files_in_use(state) -> set[str]:
  6200. """Names of the SD-card files the printer may be printing right now (#3009).
  6201. The post-print cleanup works out what to delete from the finished archive,
  6202. not from the printer. When reconciliation closes an old archive because the
  6203. printer has moved on to a new job, and that job is the same file reprinted
  6204. from the printer's screen, the cleanup would delete the file mid-print.
  6205. Empty unless the printer is busy: on an ordinary completion the state is
  6206. FINISH or FAILED and nothing is held back. ``gcode_file`` arrives as a bare
  6207. name, a path or a URL depending on firmware, and some report only the
  6208. plate's G-code, so the job name is matched as well, in the same spellings
  6209. the cleanup tries. Names are lower-cased; the card's FAT filesystem
  6210. ignores case.
  6211. """
  6212. def _text(value) -> str:
  6213. return value.strip() if isinstance(value, str) else ""
  6214. if state is None:
  6215. return set()
  6216. current_state = _text(getattr(state, "state", None)).upper()
  6217. if current_state in ("", "UNKNOWN", "IDLE", "FINISH", "FAILED"):
  6218. return set()
  6219. in_use: set[str] = set()
  6220. gcode_file = _text(getattr(state, "gcode_file", None))
  6221. if gcode_file:
  6222. # Drop a scheme by hand: urlparse would cut a name at "#" or "?",
  6223. # both legal in a file name, and raises on some inputs.
  6224. name = PurePosixPath(gcode_file.split("://", 1)[-1]).name
  6225. if name:
  6226. in_use.add(name.lower())
  6227. subtask_name = _text(getattr(state, "subtask_name", None))
  6228. if subtask_name:
  6229. for name in (subtask_name, subtask_name.replace(" ", "_")):
  6230. for ext in (".3mf", ".gcode"):
  6231. in_use.add(f"{name}{ext}".lower())
  6232. return in_use
  6233. async def reconcile_stale_active_prints(printer_id: int) -> int:
  6234. """Synthesise ``on_print_complete`` for archives whose print can't be
  6235. running on the printer anymore.
  6236. Called once per MQTT (re)connection (from on_printer_status_change when
  6237. the connected edge flips False → True) and at Bambuddy startup (from
  6238. the FastAPI lifespan). Without this, a print that completes during a
  6239. disconnect window — followed by a smart-plug-driven power cycle — leaves
  6240. the ``.3mf`` on the SD card, the firmware auto-replays it on next boot,
  6241. and Bambuddy fires a fresh PRINT START for the ghost rather than the
  6242. SD cleanup that PRINT COMPLETE was supposed to run. Repeats every
  6243. power cycle until the operator notices (#1542 follow-up). Reconciliation
  6244. closes the loop by faking the missed PRINT COMPLETE — the existing
  6245. cleanup chain handles SD-file deletion, status updates, usage tracking,
  6246. and notifications.
  6247. Synthesised ``status="aborted"`` is the conservative label: we have no
  6248. proof the print finished successfully (and no progress evidence to
  6249. promote to ``"completed"``). The real PRINT COMPLETE callback, if it
  6250. fires later, overwrites the status with the correct value.
  6251. Returns the number of archives reconciled.
  6252. """
  6253. state = printer_manager.get_status(printer_id)
  6254. if not state:
  6255. return 0
  6256. # Don't reconcile while disconnected — we'd be making a decision against
  6257. # stale cached state. The connected → reconcile edge handles this.
  6258. if not state.connected:
  6259. return 0
  6260. from backend.app.models.archive import PrintArchive
  6261. reconciled = 0
  6262. async with async_session() as db:
  6263. result = await db.execute(
  6264. select(PrintArchive).where(
  6265. PrintArchive.printer_id == printer_id,
  6266. PrintArchive.status == "printing",
  6267. )
  6268. )
  6269. active = list(result.scalars().all())
  6270. if not active:
  6271. return 0
  6272. logger = logging.getLogger(__name__)
  6273. for archive in active:
  6274. is_stale, reason = _is_active_archive_stale(archive, state)
  6275. if not is_stale:
  6276. continue
  6277. logger.info(
  6278. "[RECONCILE] Printer %s: synthesising missed PRINT COMPLETE for archive %s (%s) — %s",
  6279. printer_id,
  6280. archive.id,
  6281. archive.filename,
  6282. reason,
  6283. )
  6284. # Synthesised payload: minimal fields the on_print_complete chain
  6285. # needs. `_reconciled` marker lets downstream code distinguish this
  6286. # from a real MQTT-driven completion if it ever needs to (e.g. for
  6287. # metrics / debug logging). raw_data is the live printer state so
  6288. # the usage tracker can compare end-of-print remain% against the
  6289. # captured start values.
  6290. try:
  6291. await on_print_complete(
  6292. printer_id,
  6293. {
  6294. "status": "aborted",
  6295. "filename": archive.filename,
  6296. "subtask_name": archive.print_name or "",
  6297. "subtask_id": archive.subtask_id or "",
  6298. "raw_data": state.raw_data or {},
  6299. "_reconciled": True,
  6300. },
  6301. )
  6302. reconciled += 1
  6303. except Exception as e:
  6304. # Catch-all: a reconciliation failure must not block the
  6305. # printer's normal status flow. The archive stays in
  6306. # ``status="printing"`` and the next reconnect retries.
  6307. logger.warning(
  6308. "[RECONCILE] on_print_complete synthesis failed for archive %s: %s",
  6309. archive.id,
  6310. e,
  6311. )
  6312. return reconciled
  6313. # #2547: clearance left between the nozzle and the top of the print when the
  6314. # plate is commanded back into camera framing. The nozzle is parked away from
  6315. # the part by then, so this is belt-and-braces against a max_z_height that
  6316. # under-reports (e.g. a slicer that excludes a final Z hop).
  6317. _PLATE_RESTORE_CLEARANCE_MM = 10.0
  6318. # How far below the restored position to drop the plate again afterwards, so
  6319. # the print is as reachable as Bambu's own end G-code leaves it. Matches the
  6320. # stock `G1 Z{max_layer_z + 100}`; the firmware clamps it to the travel limit
  6321. # on machines with less headroom.
  6322. _PLATE_PARK_DROP_MM = 100.0
  6323. # Feedrate for both moves. F600 is exactly what Bambu's own end G-code uses on
  6324. # this axis, so it is a proven-safe speed for the full travel.
  6325. _PLATE_RESTORE_FEEDRATE = 600
  6326. # Time allowed for the plate to reach the restored position before the camera
  6327. # grab. Sized for the ~100 mm the stock end G-code drops at F600 (10 mm/s).
  6328. _PLATE_RESTORE_SETTLE_SECONDS = 12.0
  6329. # How long `_background_finish_photo` waits for this producer. Must cover the
  6330. # settle window plus a worst-case RTSP grab (15s), and stay below the
  6331. # notification path's own photo wait so a slow producer degrades to a
  6332. # photo-less notification rather than a missed one. The chamber light's
  6333. # snapshot delay (#1655) spends from the spare 8 seconds, which is why
  6334. # camera_light.MAX_DELAY_SECONDS stays below it.
  6335. _FINISH_PHOTO_PRODUCER_WAIT_SECONDS = _PLATE_RESTORE_SETTLE_SECONDS + 23.0
  6336. def _completion_print_keys(printer_id: int, filename: str, subtask_name: str) -> list[tuple[int, str]]:
  6337. """The ``_active_prints`` keys a finished print may be registered under.
  6338. Matching how they were registered in on_print_start. Shared by
  6339. ``on_print_complete`` and the finish-photo plate restore (#3240), which has
  6340. to find the same binding.
  6341. """
  6342. possible_keys = []
  6343. # Try subtask_name variations first (most reliable for matching)
  6344. if subtask_name:
  6345. possible_keys.append((printer_id, f"{subtask_name}.3mf"))
  6346. possible_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
  6347. possible_keys.append((printer_id, subtask_name))
  6348. # Try filename variations
  6349. if filename:
  6350. # Extract just the filename if it's a path
  6351. fname = filename.split("/")[-1] if "/" in filename else filename
  6352. if fname.endswith(".3mf"):
  6353. possible_keys.append((printer_id, fname))
  6354. elif fname.endswith(".gcode"):
  6355. base_name = fname.rsplit(".", 1)[0]
  6356. possible_keys.append((printer_id, f"{base_name}.gcode.3mf"))
  6357. possible_keys.append((printer_id, f"{base_name}.3mf"))
  6358. possible_keys.append((printer_id, fname))
  6359. else:
  6360. possible_keys.append((printer_id, f"{fname}.gcode.3mf"))
  6361. possible_keys.append((printer_id, f"{fname}.3mf"))
  6362. possible_keys.append((printer_id, fname))
  6363. # Also try full path versions
  6364. if filename.endswith(".3mf"):
  6365. possible_keys.append((printer_id, filename))
  6366. elif filename.endswith(".gcode"):
  6367. base_name = filename.rsplit(".", 1)[0]
  6368. possible_keys.append((printer_id, f"{base_name}.3mf"))
  6369. possible_keys.append((printer_id, filename))
  6370. else:
  6371. possible_keys.append((printer_id, f"{filename}.3mf"))
  6372. possible_keys.append((printer_id, filename))
  6373. return possible_keys
  6374. def _archive_name_forms(archive) -> set[str]:
  6375. """The names an archive could be echoed back as, in normalised form (#3240).
  6376. Its print name, and its filename with and without the 3MF extension.
  6377. """
  6378. forms = set()
  6379. if archive.print_name:
  6380. forms.add(_normalise_subtask_name(archive.print_name))
  6381. if archive.filename:
  6382. forms.add(_normalise_subtask_name(archive.filename))
  6383. for suffix in (".gcode.3mf", ".3mf"):
  6384. if archive.filename.lower().endswith(suffix):
  6385. forms.add(_normalise_subtask_name(archive.filename[: -len(suffix)]))
  6386. forms.discard("")
  6387. return forms
  6388. def _bound_print(printer_id: int, data: dict) -> tuple[int | None, int | None]:
  6389. """The archive and plate Bambuddy bound to the print ending on ``printer_id`` (#3240).
  6390. Read from ``_active_prints`` with the keys ``on_print_complete`` tries, and
  6391. from the plate recorded when the job was dispatched. Neither is touched:
  6392. ``on_print_complete`` pops both, which is why the finish-photo producer
  6393. calls this before its first await, while they are still there.
  6394. ``(None, None)`` for a print Bambuddy did not bind -- one it failed to
  6395. archive, or that it only knows by a name -- and on any error: the producer
  6396. calls this before the ``try`` that always releases the photo consumer, so
  6397. it must not raise.
  6398. """
  6399. try:
  6400. keys = _completion_print_keys(printer_id, str(data.get("filename") or ""), str(data.get("subtask_name") or ""))
  6401. archive_id = next((_active_prints[key] for key in keys if key in _active_prints), None)
  6402. if archive_id is None:
  6403. return None, None
  6404. return archive_id, _print_plate_ids.get(archive_id)
  6405. except Exception:
  6406. logging.getLogger(__name__).debug("Could not read the print binding for printer %s", printer_id, exc_info=True)
  6407. return None, None
  6408. async def _max_z_for_current_print(
  6409. printer_id: int,
  6410. data: dict,
  6411. logger,
  6412. archive_id: int | None,
  6413. plate_id: int | None = None,
  6414. ) -> float | None:
  6415. """Height of the print that just finished on ``printer_id``, or None (#2547).
  6416. This number becomes the target of a real Z move, so every step here refuses
  6417. rather than guesses. A height belonging to some *other* print is the one
  6418. failure that could drive the nozzle into the model: 20 mm carried onto a
  6419. 200 mm print would command the plate up through the part.
  6420. Three independent things therefore have to agree before a height is
  6421. returned:
  6422. 1. **Binding.** ``archive_id`` is the archive Bambuddy bound to this print
  6423. when it started (see ``_bound_print``), never one found by name. A name
  6424. is not an identity: every plate of a multi-plate file shares one, and a
  6425. reprint reuses its archive row, so the newest archive with the right
  6426. name can be another plate of the same file. Support bundles show the
  6427. old name lookup doing exactly that (archive 288 for a print bound to
  6428. 169, 313 layers against 125), stopped only by the layer check below.
  6429. No binding, no move.
  6430. 2. **Identity.** The bound archive's name still has to be the finished
  6431. print's ``subtask_name``, compared in ``_normalise_subtask_name`` form
  6432. because the printer echoes spaces as underscores (#3240). Exact: not a
  6433. substring, and not the completion check's tolerance for a truncated
  6434. echo.
  6435. 3. **Corroboration.** The archive's layer count (parsed from the 3MF) has to
  6436. match the layer count the printer itself reported over MQTT for the print
  6437. that just ended. These come from genuinely different sources, so a
  6438. mismatch means the row is not this print, whatever its name says.
  6439. ``plate_id`` is the plate the job was dispatched with; a reprint of one
  6440. plate of a multi-plate file reuses the archive row without updating its
  6441. ``plate_id``. ``completed`` is accepted alongside ``printing`` only because
  6442. ``on_print_complete`` may already have flipped the status by the time we
  6443. run.
  6444. """
  6445. subtask_name = (data.get("subtask_name") or "").strip()
  6446. if not subtask_name:
  6447. # Nothing to identify the print by — refuse rather than fall back to
  6448. # "whatever ran last on this printer".
  6449. logger.info("[PLATE-RESTORE] printer %s: print has no name to match on — skipping", printer_id)
  6450. return None
  6451. if archive_id is None:
  6452. logger.info(
  6453. "[PLATE-RESTORE] printer %s: %r is not bound to an archive — skipping",
  6454. printer_id,
  6455. subtask_name,
  6456. )
  6457. return None
  6458. try:
  6459. from backend.app.models.archive import PrintArchive
  6460. from backend.app.utils.threemf_tools import extract_max_z_height_from_3mf
  6461. async with async_session() as db:
  6462. result = await db.execute(
  6463. select(PrintArchive).where(
  6464. PrintArchive.id == archive_id,
  6465. PrintArchive.printer_id == printer_id,
  6466. PrintArchive.status.in_(("printing", "completed")),
  6467. PrintArchive.deleted_at.is_(None),
  6468. )
  6469. )
  6470. archive = result.scalar_one_or_none()
  6471. if archive is None or not archive.file_path:
  6472. logger.info("[PLATE-RESTORE] printer %s: archive %s has no usable file — skipping", printer_id, archive_id)
  6473. return None
  6474. if _normalise_subtask_name(subtask_name) not in _archive_name_forms(archive):
  6475. logger.warning(
  6476. "[PLATE-RESTORE] printer %s: archive %s is not named %r — refusing to move the plate",
  6477. printer_id,
  6478. archive_id,
  6479. subtask_name,
  6480. )
  6481. return None
  6482. client = printer_manager.get_client(printer_id)
  6483. reported_layers = getattr(getattr(client, "state", None), "total_layers", None)
  6484. if reported_layers and archive.total_layers and reported_layers != archive.total_layers:
  6485. logger.warning(
  6486. "[PLATE-RESTORE] printer %s: archive %s says %s layers but the printer reported %s "
  6487. "— refusing to move the plate on a height that may not be this print's",
  6488. printer_id,
  6489. archive.id,
  6490. archive.total_layers,
  6491. reported_layers,
  6492. )
  6493. return None
  6494. # Stored relative to the data directory, like every other archive path
  6495. # (#3240: this read a `data_dir` setting that does not exist).
  6496. path = app_settings.base_dir / archive.file_path
  6497. plate = plate_id or archive.plate_id or 1
  6498. return await asyncio.to_thread(extract_max_z_height_from_3mf, path, plate)
  6499. except Exception as e:
  6500. logger.debug("[PLATE-RESTORE] printer %s: no usable print height: %s", printer_id, e)
  6501. return None
  6502. async def _restore_plate_for_finish_photo(printer_id: int, max_z_height: float, logger) -> bool:
  6503. """Raise the plate back into camera framing before the finish photo (#2547).
  6504. Bambu's end G-code drops the plate ~100 mm as the last thing it does, so by
  6505. the time ``gcode_state`` reaches FINISH the finished print sits far below
  6506. the camera's natural framing — the complaint behind #1145, #1397 and #1565.
  6507. This commands an absolute ``G1 Z`` back to just above the last printed
  6508. layer.
  6509. Absolute, not relative, is the whole safety argument. ``max_z_height +
  6510. clearance`` is a height the toolhead was physically at seconds earlier, so
  6511. it is inside the travel limits by construction and leaves the nozzle above
  6512. the part. It is also unambiguous across model families: Z is the
  6513. nozzle-to-bed gap whether the bed moves (X1/P1/H2) or the toolhead does
  6514. (A1), so unlike the relative bed-jog path (#1334) there is no sign to get
  6515. wrong. ``M211`` is never touched — see the bed-jog docstring for why
  6516. (#2579).
  6517. Returns True if the move was sent and waited out, False if it was skipped.
  6518. """
  6519. client = printer_manager.get_client(printer_id)
  6520. if client is None:
  6521. return False
  6522. # Re-read state immediately before commanding motion. If the queue has
  6523. # already started the next print, the printer is no longer ours to move.
  6524. state = getattr(client, "state", None)
  6525. if state is None or state.state != "FINISH":
  6526. logger.info(
  6527. "[PLATE-RESTORE] printer %s is in state %s, not FINISH — skipping",
  6528. printer_id,
  6529. getattr(state, "state", "unknown"),
  6530. )
  6531. return False
  6532. target_z = max_z_height + _PLATE_RESTORE_CLEARANCE_MM
  6533. if not client.send_gcode(f"G90\nG1 Z{target_z:.2f} F{_PLATE_RESTORE_FEEDRATE}"):
  6534. logger.warning("[PLATE-RESTORE] printer %s: send failed — capturing where it is", printer_id)
  6535. return False
  6536. logger.info(
  6537. "[PLATE-RESTORE] printer %s: plate to Z%.2f (print top %.2f + %.1f clearance), settling %.0fs",
  6538. printer_id,
  6539. target_z,
  6540. max_z_height,
  6541. _PLATE_RESTORE_CLEARANCE_MM,
  6542. _PLATE_RESTORE_SETTLE_SECONDS,
  6543. )
  6544. await asyncio.sleep(_PLATE_RESTORE_SETTLE_SECONDS)
  6545. return True
  6546. def _park_plate_after_finish_photo(printer_id: int, max_z_height: float, logger) -> None:
  6547. """Drop the plate again after the finish photo (#2547).
  6548. Without this the user walks up to a finished print sitting just under the
  6549. nozzle, which is exactly the position Bambu's end G-code goes out of its way
  6550. to avoid — awkward to lift the plate out, and easy to knock the toolhead.
  6551. Fire-and-forget: if it doesn't land, the plate is merely high, and the next
  6552. print homes anyway.
  6553. """
  6554. client = printer_manager.get_client(printer_id)
  6555. state = getattr(client, "state", None) if client else None
  6556. if client is None or state is None or state.state != "FINISH":
  6557. return
  6558. client.send_gcode(f"G90\nG1 Z{max_z_height + _PLATE_PARK_DROP_MM:.2f} F{_PLATE_RESTORE_FEEDRATE}")
  6559. logger.debug("[PLATE-RESTORE] printer %s: plate returned to unload height", printer_id)
  6560. async def _plate_restore_is_blocked_by_queue(printer_id: int) -> bool:
  6561. """True if a queue item is about to take this printer (#2547).
  6562. The scheduler dispatches the next job the moment a print completes, and a
  6563. plate move interleaved with a print start is not a race worth having. The
  6564. state re-check in ``_restore_plate_for_finish_photo`` closes the tail of
  6565. this window; this closes the head of it.
  6566. """
  6567. try:
  6568. from backend.app.models.print_queue import PrintQueueItem
  6569. async with async_session() as db:
  6570. result = await db.execute(
  6571. select(PrintQueueItem.id)
  6572. .where(
  6573. PrintQueueItem.printer_id == printer_id,
  6574. PrintQueueItem.status.in_(("pending", "printing")),
  6575. )
  6576. .limit(1)
  6577. )
  6578. return result.scalar_one_or_none() is not None
  6579. except Exception as e:
  6580. # Fail closed: if we can't tell, don't move the plate.
  6581. logging.getLogger(__name__).debug(
  6582. "[PLATE-RESTORE] queue check failed for printer %s: %s — skipping restore", printer_id, e
  6583. )
  6584. return True
  6585. async def on_finish_photo_moment(printer_id: int, data: dict):
  6586. """Pre-capture a finish photo when the printer enters stage 22 / FINISH (#1721).
  6587. Fires either at the stage-22 ("Filament unloading") edge — toolhead
  6588. parked, bed not yet dropped, optimal framing — or as a FINISH-state
  6589. fallback for prints that skip stage 22 (cancel, external-spool-only,
  6590. HMS halt, firmware variants). Grabs one frame via the same
  6591. external-camera / RTSP path the post-completion fallback uses, stores
  6592. the JPEG bytes in ``_stage22_finish_frames[printer_id]``, and lets
  6593. ``_background_finish_photo`` consume the cached bytes when it runs.
  6594. Replaces the #1397 "force timelapse on at dispatch" mechanism, which
  6595. caused per-layer nozzle parking on slicer profiles with Timelapse Type
  6596. set to Smooth (#1721). No force-on now means the user's explicit
  6597. timelapse=off in the slicer send dialog is respected.
  6598. """
  6599. logger = logging.getLogger(__name__)
  6600. trigger = data.get("trigger", "unknown")
  6601. timelapse_was_active = bool(data.get("timelapse_was_active"))
  6602. logger.info(
  6603. "[FINISH-PHOTO-MOMENT] printer=%s trigger=%s timelapse_active=%s",
  6604. printer_id,
  6605. trigger,
  6606. timelapse_was_active,
  6607. )
  6608. # If a timelapse is actively recording, skip the pre-capture — the
  6609. # post-completion path will extract the last frame from the recorded
  6610. # video, which still provides the best framing (toolhead parked,
  6611. # before bed drop) without the per-layer parking side effects.
  6612. if timelapse_was_active:
  6613. logger.info(
  6614. "[FINISH-PHOTO-MOMENT] timelapse active for printer %s — skipping pre-capture (last-frame extraction will run post-completion)",
  6615. printer_id,
  6616. )
  6617. return
  6618. # #1790: register the producer-done event BEFORE the first await so the
  6619. # consumer in `_background_finish_photo` — which is dispatched back-to-back
  6620. # with us on the FINISH-state fallback path — sees it as soon as it polls.
  6621. # The `finally` below guarantees `set()` runs on every exit, including
  6622. # early returns and exceptions, so the consumer's bounded wait can't hang.
  6623. producer_done = asyncio.Event()
  6624. _stage22_finish_in_flight[printer_id] = producer_done
  6625. # #3240: also before the first await. On the FINISH-state path
  6626. # `on_print_complete` is dispatched right behind us and pops both the
  6627. # print's archive binding and its plate; read here, they are still there.
  6628. bound_archive_id, bound_plate_id = _bound_print(printer_id, data)
  6629. # #2547: set once the plate has actually been raised, and read by the
  6630. # `finally` below. Declared out here so a failure anywhere after the move —
  6631. # a camera timeout, a DB error — still lowers the plate again.
  6632. restore_max_z: float | None = None
  6633. try:
  6634. async with async_session() as db:
  6635. from backend.app.api.routes.settings import get_setting
  6636. from backend.app.models.printer import Printer
  6637. capture_setting = await get_setting(db, "capture_finish_photo")
  6638. if capture_setting is not None and capture_setting.lower() != "true":
  6639. logger.info("[FINISH-PHOTO-MOMENT] capture_finish_photo disabled — skipping pre-capture")
  6640. return
  6641. restore_setting = await get_setting(db, "finish_photo_restore_plate")
  6642. restore_plate_enabled = restore_setting is None or restore_setting.lower() == "true"
  6643. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  6644. printer = result.scalar_one_or_none()
  6645. if printer is None:
  6646. logger.warning(
  6647. "[FINISH-PHOTO-MOMENT] printer %s not found in DB",
  6648. printer_id,
  6649. )
  6650. return
  6651. frame_bytes: bytes | None = None
  6652. # #2708: the banked frame arrives already rotated — it comes from
  6653. # `_capture_snapshot_for_notification`, which rotates before returning.
  6654. # Every other source below is a raw grab. Tracking which lets us store
  6655. # exactly one rotation in `_stage22_finish_frames` either way.
  6656. frame_already_rotated = False
  6657. # On the FINISH-state path the End G-code has already run, and two very
  6658. # different situations arrive here needing opposite answers.
  6659. #
  6660. # #1867: if Bambuddy injected End G-code into this print, a SwapMod
  6661. # snippet may have ejected the plate — the scene in front of the camera
  6662. # is no longer the finished print, and no amount of moving the plate
  6663. # brings it back. Use the banked in-print frame instead.
  6664. #
  6665. # #2547: otherwise the print is still sitting there, just ~100 mm lower
  6666. # than the camera frames well, and the toolhead is parked out of the
  6667. # way. That is the *best* moment available on firmware that never emits
  6668. # stage 22 (H2C, A1 Mini) — so capture live, after putting the plate
  6669. # back. Preferring the bank here unconditionally, as this code used to,
  6670. # is what shipped a mid-print photo with the toolhead over the part.
  6671. if trigger == "finish_state" and print_dispatch_context.end_gcode_injected(printer_id):
  6672. banked = _inprint_frame_bank.get(printer_id)
  6673. if banked:
  6674. frame_bytes = banked
  6675. frame_already_rotated = True
  6676. logger.info(
  6677. "[FINISH-PHOTO-MOMENT] End G-code was injected — using banked in-print "
  6678. "frame (%d bytes) instead of a post-swap live grab",
  6679. len(banked),
  6680. )
  6681. else:
  6682. logger.warning(
  6683. "[FINISH-PHOTO-MOMENT] End G-code was injected for printer %s but the "
  6684. "in-print bank is empty — falling back to a live grab, which may show a "
  6685. "swapped or empty plate",
  6686. printer_id,
  6687. )
  6688. # `restore_max_z` is set only once the plate is actually up, because the
  6689. # `finally` reads it to decide whether it owes a move back down.
  6690. #
  6691. # Never on a print whose End G-code Bambuddy injected, even when the bank
  6692. # came up empty above: that machine may have just ejected its plate, and
  6693. # driving Z into whatever a swap mechanism is doing is not a risk worth
  6694. # taking for a photo of a bed we already know may be bare.
  6695. if (
  6696. frame_bytes is None
  6697. and trigger == "finish_state"
  6698. and restore_plate_enabled
  6699. and not print_dispatch_context.end_gcode_injected(printer_id)
  6700. ):
  6701. wants_restore = await _max_z_for_current_print(printer_id, data, logger, bound_archive_id, bound_plate_id)
  6702. if wants_restore is None:
  6703. logger.info(
  6704. "[PLATE-RESTORE] printer %s: print height unknown — capturing without restore",
  6705. printer_id,
  6706. )
  6707. elif await _plate_restore_is_blocked_by_queue(printer_id):
  6708. logger.info(
  6709. "[PLATE-RESTORE] printer %s has queued work — skipping plate restore",
  6710. printer_id,
  6711. )
  6712. elif await _restore_plate_for_finish_photo(printer_id, wants_restore, logger):
  6713. restore_max_z = wants_restore
  6714. # Chamber light for the live capture below (#1655). The banked frame
  6715. # above was taken without it, like every in-print bank.
  6716. async with camera_light(printer if frame_bytes is None else None):
  6717. if frame_bytes is None and printer.external_camera_enabled and printer.external_camera_url:
  6718. from backend.app.api.routes.camera import live_frame_for_capture
  6719. from backend.app.services.external_camera import capture_frame
  6720. # #2707: this used to collide with the live view and fail, which is
  6721. # how finish-photo notifications went out with no image attached.
  6722. # Leaving frame_bytes None keeps the rest of the fallback chain.
  6723. defer, buffered = live_frame_for_capture(printer_id)
  6724. if defer:
  6725. frame_bytes = buffered
  6726. else:
  6727. frame_bytes = await capture_frame(
  6728. printer.external_camera_url,
  6729. printer.external_camera_type or "mjpeg",
  6730. snapshot_url=printer.external_camera_snapshot_url,
  6731. )
  6732. if frame_bytes:
  6733. logger.info(
  6734. "[FINISH-PHOTO-MOMENT] captured external-camera frame (%d bytes)",
  6735. len(frame_bytes),
  6736. )
  6737. elif frame_bytes is None:
  6738. from backend.app.api.routes.camera import get_buffered_frame
  6739. buffered = get_buffered_frame(printer_id)
  6740. if buffered:
  6741. frame_bytes = buffered
  6742. logger.info(
  6743. "[FINISH-PHOTO-MOMENT] used buffered RTSP frame (%d bytes)",
  6744. len(frame_bytes),
  6745. )
  6746. else:
  6747. from backend.app.services.camera import capture_camera_frame_bytes
  6748. frame_bytes = await capture_camera_frame_bytes(
  6749. ip_address=printer.ip_address,
  6750. access_code=printer.access_code,
  6751. model=printer.model,
  6752. timeout=15,
  6753. )
  6754. if frame_bytes:
  6755. logger.info(
  6756. "[FINISH-PHOTO-MOMENT] captured RTSP frame (%d bytes)",
  6757. len(frame_bytes),
  6758. )
  6759. if frame_bytes:
  6760. if not frame_already_rotated:
  6761. frame_bytes = _apply_camera_rotation(frame_bytes, printer, logger)
  6762. _stage22_finish_frames[printer_id] = frame_bytes
  6763. else:
  6764. logger.warning(
  6765. "[FINISH-PHOTO-MOMENT] no frame captured for printer %s — post-completion fallback will retry",
  6766. printer_id,
  6767. )
  6768. except Exception as e:
  6769. logger.warning(
  6770. "[FINISH-PHOTO-MOMENT] pre-capture failed for printer %s: %s",
  6771. printer_id,
  6772. e,
  6773. )
  6774. finally:
  6775. # #2547: we raised the plate, so we own lowering it — including when the
  6776. # capture above failed or threw partway through.
  6777. if restore_max_z is not None:
  6778. try:
  6779. _park_plate_after_finish_photo(printer_id, restore_max_z, logger)
  6780. except Exception as e:
  6781. logger.warning("[PLATE-RESTORE] printer %s: could not lower plate: %s", printer_id, e)
  6782. # #1790: always unblock the consumer's bounded wait — whether we stored
  6783. # a frame, gave up, or hit an exception. Local ref means cleanup of the
  6784. # dict entry by the consumer doesn't affect signalling.
  6785. producer_done.set()
  6786. def _subtask_name_from_filename(filename: str) -> str:
  6787. """Recover the subtask name a print command would have carried for *filename*.
  6788. The dispatcher derives the printer-facing subtask name from the archive's
  6789. file name, so stripping the extensions back off gives the value MQTT echoes
  6790. on completion. Only the two extensions Bambuddy actually stores are removed,
  6791. and in the order they nest (``.gcode.3mf``), so a model whose own name
  6792. contains a dot -- ``My.Model.3mf`` -- keeps it.
  6793. """
  6794. name = PurePosixPath(filename).name
  6795. for suffix in (".3mf", ".gcode"):
  6796. if name.lower().endswith(suffix):
  6797. name = name[: -len(suffix)]
  6798. return name
  6799. def _subtask_is_the_file(subtask_name: str, filename: str) -> bool:
  6800. """Whether the subtask name is the printed 3MF's own file name.
  6801. A print started from the printer's screen reports the same full name, with
  6802. its extension, as both subtask and file (#3009). A dispatched print reports
  6803. a bare subtask name; one that merely ends in ".3mf" can be a model named
  6804. that, whose file is ``Foo.3mf.gcode.3mf``, so it does not count.
  6805. """
  6806. if not subtask_name or not subtask_name.lower().endswith(".3mf"):
  6807. return False
  6808. return PurePosixPath((filename or "").split("://", 1)[-1]).name == subtask_name
  6809. # How the printer marks a subtask name it had to cut short. Observed on real
  6810. # hardware at ~100 characters, but the cut-off is not a fixed character count
  6811. # (a name with multibyte characters came back at 98), so match the marker
  6812. # rather than a length.
  6813. _SUBTASK_TRUNCATION_MARKER = "..."
  6814. def _normalise_subtask_name(name: str) -> str:
  6815. """Canonical form for comparing a dispatched name against MQTT's echo.
  6816. The printer does not echo the name back verbatim: it substitutes
  6817. underscores for spaces. ``H2D_Carbon_Filter_(V2)_Body & Solid Lid`` is
  6818. dispatched and ``H2D_Carbon_Filter_(V2)_Body_&_Solid_Lid`` comes back.
  6819. The 3MF lookup in this module has always known that -- it builds
  6820. space-to-underscore variants of every candidate filename, and its
  6821. directory search normalises both sides before comparing. This exists so
  6822. the completion check reads the same rule from the same place instead of
  6823. growing its own, which is exactly how it came to disagree (#2829).
  6824. A space at either end is substituted too: ``Part .gcode.3mf`` is
  6825. dispatched as ``Part `` and echoed as ``Part_``. Underscores at the ends
  6826. are dropped after the substitution so both sides agree (#3241).
  6827. """
  6828. return name.strip().replace(" ", "_").strip("_").casefold()
  6829. def _3mf_files_for_print(paths: list[str], search_term: str) -> list[str]:
  6830. """The 3MF files of the printer's folder listings that are this print's.
  6831. A file of the print's own name wins, in whichever folder. Only without one
  6832. is a file that merely contains the name taken, and then only when it is
  6833. the one such file: "Cube_large.3mf" is not "Cube"'s file, and of several
  6834. candidates none can be told apart. Paths keep the listings' order.
  6835. """
  6836. threemf = [path for path in paths if path.lower().endswith(".3mf")]
  6837. exact = [path for path in threemf if _subtask_names_match(_subtask_name_from_filename(path), search_term)]
  6838. if exact:
  6839. return exact
  6840. term = _normalise_subtask_name(search_term)
  6841. partial = [path for path in threemf if term in _normalise_subtask_name(PurePosixPath(path).name)]
  6842. if len(partial) > 1:
  6843. logging.getLogger(__name__).info(
  6844. "Several 3MF files contain %r and none is named for it: %s", search_term, partial
  6845. )
  6846. return []
  6847. return partial
  6848. def _subtask_names_match(expected: str, observed: str) -> bool:
  6849. """Whether two subtask names describe the same print.
  6850. Beyond the space/underscore substitution, the printer truncates long names
  6851. and marks the cut with ``...``. A truncated echo has to count as a match or
  6852. every print with a long name strands its queue item the same way.
  6853. """
  6854. expected_n = _normalise_subtask_name(expected)
  6855. observed_n = _normalise_subtask_name(observed)
  6856. if expected_n == observed_n:
  6857. return True
  6858. # Either side can be the truncated one: the printer truncates what it
  6859. # echoes, and an archive whose own filename was recorded from a previous
  6860. # truncated echo carries the marker too.
  6861. for full, cut in ((expected_n, observed_n), (observed_n, expected_n)):
  6862. if not cut.endswith(_SUBTASK_TRUNCATION_MARKER):
  6863. continue
  6864. # The full side has lost its edge underscores; a cut that lands right
  6865. # after one keeps it, so drop it here too (#3241). Nothing left before
  6866. # the marker is no evidence of anything, and must not match every name.
  6867. kept = cut[: -len(_SUBTASK_TRUNCATION_MARKER)].rstrip("_")
  6868. if kept and full.startswith(kept):
  6869. return True
  6870. return False
  6871. async def _queue_item_dispatched_name(db, item) -> str:
  6872. """The subtask name *item* was dispatched under, or "" when unknowable.
  6873. A row with no archive, or an archive with no file name, is unverifiable
  6874. rather than wrong; every caller answers that with its permissive branch.
  6875. """
  6876. if item.archive_id is None:
  6877. return ""
  6878. from backend.app.models.archive import PrintArchive
  6879. archive = await db.get(PrintArchive, item.archive_id)
  6880. if archive is None or not archive.filename:
  6881. return ""
  6882. return _subtask_name_from_filename(archive.filename)
  6883. async def _completion_belongs_to_queue_item(db, item, data: dict) -> bool:
  6884. """Whether this completion event is plausibly about *item*'s print.
  6885. The caller finds its queue row by printer and ``status='printing'`` alone,
  6886. which is all a completion event gives it -- there is no run identifier in
  6887. the MQTT payload to match on. That makes the lookup indiscriminate: any
  6888. completion delivered for this printer closes whichever row happens to be
  6889. printing, however unrelated. Comparing the subtask name against the archive
  6890. the row was dispatched with costs one primary-key load and rules that out.
  6891. Deliberately permissive: it answers False only on a positive disagreement
  6892. between two names we actually have. A row with no archive, an archive with
  6893. no file name, or an event with no subtask name is unverifiable rather than
  6894. wrong, and refusing those would strand the item in ``printing`` and wedge
  6895. the printer's queue -- a worse failure than the one being prevented.
  6896. """
  6897. observed = (data.get("subtask_name") or "").strip()
  6898. if not observed or item.archive_id is None:
  6899. return True
  6900. from backend.app.models.archive import PrintArchive
  6901. archive = await db.get(PrintArchive, item.archive_id)
  6902. if archive is None or not archive.filename:
  6903. return True
  6904. expected = _subtask_name_from_filename(archive.filename)
  6905. if not expected or _subtask_names_match(expected, observed):
  6906. return True
  6907. logging.getLogger(__name__).warning(
  6908. "Ignoring print completion for queue item %s: it was dispatched as %r "
  6909. "(archive %s, %s) but the completion reports subtask %r. Leaving the item "
  6910. "printing rather than closing a run this event is not about.",
  6911. item.id,
  6912. expected,
  6913. archive.id,
  6914. archive.filename,
  6915. observed,
  6916. )
  6917. return False
  6918. async def _recover_fallback_from_cache_before_eviction(printer_id: int, data: dict) -> None:
  6919. """Spend the 3MF download cache on a still-empty fallback archive.
  6920. ``on_print_complete`` drops the cache as its first act, which deletes the
  6921. file. If the cover endpoint (or anything else) pulled the 3MF while the
  6922. print ran and the archive never got one, this is the last moment those bytes
  6923. exist (#2957).
  6924. """
  6925. logger = logging.getLogger(__name__)
  6926. names = [
  6927. n
  6928. for n in (data.get("filename"), data.get("subtask_name"), (data.get("raw_data") or {}).get("subtask_name"))
  6929. if n
  6930. ]
  6931. for name in names:
  6932. try:
  6933. cached = get_cached_3mf(printer_id, name)
  6934. # The print has ended: its completion prices the archive, so no
  6935. # print-start estimate is scheduled to race it.
  6936. if cached and await try_recover_fallback_archive(printer_id, name, cached, price=False):
  6937. return
  6938. except Exception as e:
  6939. logger.debug("[RECOVER] Pre-eviction recovery for %s failed: %s", name, e)
  6940. async def _cleanup_sd_card_after_print(
  6941. printer_id: int, subtask_name: str | None, archive_id: int | None, logger
  6942. ) -> None:
  6943. """Delete a finished print's file from the printer's SD card."""
  6944. # Cleanup: delete uploaded file from printer SD card to prevent phantom prints (Issue #374, #1542)
  6945. # The print scheduler uploads files to the SD card root (/). Some printers (e.g. P1S, A1)
  6946. # auto-start files found in root on power cycle, causing ghost prints.
  6947. # Must run before the archive_id early-return so it executes even when archiving is disabled.
  6948. try:
  6949. if subtask_name:
  6950. archive_filename: str | None = None
  6951. async with async_session() as db:
  6952. from backend.app.models.archive import PrintArchive
  6953. from backend.app.models.printer import Printer
  6954. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  6955. printer = result.scalar_one_or_none()
  6956. if archive_id:
  6957. archive_row = await db.execute(select(PrintArchive.filename).where(PrintArchive.id == archive_id))
  6958. archive_filename = archive_row.scalar_one_or_none()
  6959. if printer:
  6960. from backend.app.services.bambu_ftp import DeleteResult, delete_file_async
  6961. from backend.app.utils.filename import derive_remote_filename
  6962. # Primary candidate: the exact path the dispatcher uploaded to
  6963. # (derived from archive.filename via the same rule as upload).
  6964. # Without it, a library row that ended up with a doubled
  6965. # .gcode.3mf (#1542) leaves the real file behind because the
  6966. # subtask_name + ext fallbacks below don't match what's on the
  6967. # SD card. Fallbacks remain for archive-less prints (subtask
  6968. # never resolved to an archive) and for older naming variants.
  6969. candidate_paths: list[str] = []
  6970. if archive_filename:
  6971. candidate_paths.append(f"/{derive_remote_filename(archive_filename)}")
  6972. for ext in (".3mf", ".gcode"):
  6973. fallback = f"/{subtask_name}{ext}"
  6974. if fallback not in candidate_paths:
  6975. candidate_paths.append(fallback)
  6976. # Three outcomes track across all candidates so the final log
  6977. # line reflects what actually happened. The A1 in #1721 always
  6978. # ends here with ``any_not_found=True`` and the others False
  6979. # — its firmware auto-cleans the SD card before our cleanup
  6980. # runs, every candidate FTP-DELE returns 550, and the old
  6981. # code burned 3 retries × 2 s × 3 candidates per print
  6982. # logging a misleading "may linger" WARNING on a successful
  6983. # print.
  6984. any_deleted = False
  6985. any_real_failure = False
  6986. any_not_found = False
  6987. files_in_use = _sd_files_in_use(printer_manager.get_status(printer_id))
  6988. for remote_path in candidate_paths:
  6989. if PurePosixPath(remote_path).name.lower() in files_in_use:
  6990. logger.info(
  6991. "SD card cleanup: keeping %s on printer %s, which is printing it now",
  6992. remote_path,
  6993. printer.name,
  6994. )
  6995. continue
  6996. # Retry only the FAILED case — 550 NOT_FOUND will never
  6997. # recover by waiting, so a "file isn't here" answer
  6998. # advances immediately to the next candidate without
  6999. # consuming the retry budget.
  7000. for attempt in range(1, 4):
  7001. try:
  7002. delete_result = await delete_file_async(
  7003. printer.ip_address,
  7004. printer.access_code,
  7005. remote_path,
  7006. printer_model=printer.model,
  7007. )
  7008. except Exception as e:
  7009. delete_result = DeleteResult.FAILED
  7010. logger.warning(
  7011. "SD card cleanup attempt %d/3 raised for %s: %s",
  7012. attempt,
  7013. remote_path,
  7014. e,
  7015. )
  7016. if delete_result == DeleteResult.DELETED:
  7017. any_deleted = True
  7018. logger.info("Deleted %s from printer %s SD card", remote_path, printer.name)
  7019. break
  7020. if delete_result == DeleteResult.NOT_FOUND:
  7021. any_not_found = True
  7022. break # 550 will not recover; try next candidate
  7023. # FAILED: real error — retry with backoff, then give up
  7024. if attempt < 3:
  7025. await asyncio.sleep(2)
  7026. else:
  7027. any_real_failure = True
  7028. logger.warning(
  7029. "SD card cleanup failed after 3 attempts for %s "
  7030. "(network/auth/transient error — file may linger on SD card)",
  7031. remote_path,
  7032. )
  7033. if not any_deleted and not any_real_failure and any_not_found:
  7034. # Every candidate said "not here." Either the printer
  7035. # firmware swept the SD card itself (common on A1) or the
  7036. # dispatcher's upload path doesn't match our candidate
  7037. # rule. Either way: nothing to clean up, no warning.
  7038. logger.debug(
  7039. "SD card cleanup: nothing to delete on %s — every candidate returned 550 "
  7040. "(printer likely self-cleaned)",
  7041. printer.name,
  7042. )
  7043. except Exception as e:
  7044. logger.warning("SD card file cleanup failed for printer %s: %s", printer_id, e)
  7045. async def on_print_complete(printer_id: int, data: dict):
  7046. """Handle print completion - update the archive status."""
  7047. import time
  7048. logger = logging.getLogger(__name__)
  7049. start_time = time.time()
  7050. def log_timing(section: str):
  7051. elapsed = time.time() - start_time
  7052. logger.info("[TIMING] %s: %.3fs elapsed", section, elapsed)
  7053. logger.info("[CALLBACK] on_print_complete started for printer %s", printer_id)
  7054. # A kill-switch stop sends its provider notification immediately. Keep the
  7055. # task so the later notification path can await it and avoid a duplicate;
  7056. # if that immediate attempt failed, the regular completion path retries.
  7057. kill_switch_notification_task = _kill_switch_notification_tasks.pop(printer_id, None)
  7058. # Last chance before the bytes go: if this print's archive is still an empty
  7059. # fallback and something downloaded the 3MF while it ran, fill the archive in
  7060. # now. The cover endpoint's copy lives in exactly this cache, and clearing it
  7061. # below deletes the file (#2957).
  7062. await _recover_fallback_from_cache_before_eviction(printer_id, data)
  7063. # A pending cool-off retry has nothing left to recover for — the cache is
  7064. # about to be dropped and the print is over.
  7065. retry_task = _fallback_3mf_retry_tasks.pop(printer_id, None)
  7066. if retry_task and not retry_task.done():
  7067. retry_task.cancel()
  7068. # Drop the 3MF download cache for this printer (#972). The print is over,
  7069. # nothing else legitimately needs the bytes; keeping them would only risk
  7070. # handing a stale file to the next print if it reuses the same name.
  7071. clear_3mf_cache(printer_id)
  7072. try:
  7073. ws_data = {
  7074. "status": data.get("status"),
  7075. "filename": data.get("filename"),
  7076. "subtask_name": data.get("subtask_name"),
  7077. "timelapse_was_active": data.get("timelapse_was_active"),
  7078. }
  7079. await ws_manager.send_print_complete(printer_id, ws_data)
  7080. log_timing("WebSocket send_print_complete")
  7081. except Exception as e:
  7082. logger.warning("[CALLBACK] WebSocket send_print_complete failed: %s", e)
  7083. # Capture user info before clearing (needed for print log entry)
  7084. _print_user_info = printer_manager.get_current_print_user(printer_id)
  7085. # Clear current print user tracking (Issue #206)
  7086. printer_manager.clear_current_print_user(printer_id)
  7087. # If the user explicitly stopped this print from the queue UI the printer will
  7088. # report "failed" or "aborted" via MQTT. Override that to "cancelled" so the
  7089. # correct "print stopped" notification/email is sent instead of a failure alert.
  7090. _raw_status = data.get("status", "completed")
  7091. if printer_id in _user_stopped_printers and _raw_status in ("failed", "aborted"):
  7092. logger.info(
  7093. "[CALLBACK] Overriding status '%s' -> 'cancelled' for printer %s (print was stopped from queue by user)",
  7094. _raw_status,
  7095. printer_id,
  7096. )
  7097. data = {**data, "status": "cancelled"}
  7098. elif printer_id in _kill_switch_stopped and _raw_status in ("failed", "aborted"):
  7099. logger.info(
  7100. "[CALLBACK] Overriding status '%s' -> 'cancelled' for printer %s (stopped by the printer kill switch)",
  7101. _raw_status,
  7102. printer_id,
  7103. )
  7104. data = {**data, "status": "cancelled", "_kill_switch": True}
  7105. _user_stopped_printers.discard(printer_id)
  7106. _kill_switch_stopped.discard(printer_id)
  7107. # Raise the plate-clear gate for queued dispatch (#961). Any terminal status
  7108. # may have left material on the bed: a user can cancel ten hours into a
  7109. # twelve-hour print, a printer can self-abort mid-job after a clog, and a
  7110. # touchscreen-stop reports `aborted` rather than `cancelled` because
  7111. # `_user_stopped_printers` is only populated when the user stops via the
  7112. # Bambuddy queue UI. Earlier code raised the flag only for completed/failed,
  7113. # which auto-dispatched the next queued print onto a fouled bed two seconds
  7114. # after a touchscreen-abort (#1171). Persisted to DB so the gate survives
  7115. # Auto Off power cycles and Bambuddy restarts.
  7116. try:
  7117. notify_live_activities.print_finished(printer_id, data)
  7118. except Exception:
  7119. logger.exception("Notify Live Activity completion hook failed for printer %s", printer_id)
  7120. _final_status = data.get("status", "completed")
  7121. if _final_status in ("completed", "failed", "aborted", "cancelled"):
  7122. printer_manager.set_awaiting_plate_clear(printer_id, True)
  7123. # MQTT relay - publish print complete
  7124. try:
  7125. printer_info = printer_manager.get_printer(printer_id)
  7126. if printer_info:
  7127. await mqtt_relay.on_print_complete(
  7128. printer_id,
  7129. printer_info.name,
  7130. printer_info.serial_number,
  7131. data.get("filename", ""),
  7132. data.get("subtask_name", ""),
  7133. data.get("status", "completed"),
  7134. )
  7135. except Exception:
  7136. pass # Don't fail print complete callback if MQTT fails
  7137. filename = data.get("filename", "")
  7138. subtask_name = data.get("subtask_name", "")
  7139. if not filename and not subtask_name:
  7140. logger.warning("Print complete without filename or subtask_name")
  7141. return
  7142. logger.info("Print complete - filename: %s, subtask: %s, status: %s", filename, subtask_name, data.get("status"))
  7143. # Build list of possible keys to try (matching how they were registered in on_print_start)
  7144. possible_keys = _completion_print_keys(printer_id, filename, subtask_name)
  7145. # Find the archive for this print
  7146. logger.info("Looking for archive in _active_prints, keys to try: %s...", possible_keys[:5])
  7147. logger.info("Current _active_prints: %s", list(_active_prints.keys()))
  7148. archive_id = None
  7149. for key in possible_keys:
  7150. archive_id = _active_prints.pop(key, None)
  7151. if archive_id:
  7152. _owned_print_archive_ids.discard(archive_id)
  7153. logger.info("Found archive %s with key %s", archive_id, key)
  7154. # Also clean up any other keys pointing to this archive
  7155. keys_to_remove = [k for k, v in _active_prints.items() if v == archive_id]
  7156. for k in keys_to_remove:
  7157. _active_prints.pop(k, None)
  7158. break
  7159. # The archive bound when the print started, before the name search below.
  7160. # Only this one may give the finish-photo plate restore a height (#3240):
  7161. # the search matches names by substring.
  7162. bound_archive_id = archive_id
  7163. if not archive_id:
  7164. # Try to find by filename or subtask_name if not tracked (for prints started before app)
  7165. async with async_session() as db:
  7166. from backend.app.models.archive import PrintArchive
  7167. # Try matching by subtask_name (stored as print_name) first. The
  7168. # same name rule as the queue's completion check: a name inside
  7169. # another ("Clip" in "Cable Clip") is a different print, and the
  7170. # printer's underscores for spaces and truncation still match.
  7171. if subtask_name:
  7172. printing = await db.scalars(
  7173. select(PrintArchive)
  7174. .where(PrintArchive.printer_id == printer_id)
  7175. .where(PrintArchive.status == "printing")
  7176. .order_by(PrintArchive.created_at.desc())
  7177. )
  7178. # A print started from the printer's screen reports its file
  7179. # name, extensions included, as the subtask (#3009).
  7180. reported = {subtask_name, _subtask_name_from_filename(subtask_name)}
  7181. archive = next(
  7182. (
  7183. candidate
  7184. for candidate in printing
  7185. if any(
  7186. (candidate.print_name and _subtask_names_match(candidate.print_name, name))
  7187. or (
  7188. candidate.filename
  7189. and _subtask_names_match(_subtask_name_from_filename(candidate.filename), name)
  7190. )
  7191. for name in reported
  7192. )
  7193. ),
  7194. None,
  7195. )
  7196. if archive:
  7197. archive_id = archive.id
  7198. logger.info("Found archive %s by subtask_name match: %s", archive_id, subtask_name)
  7199. # Also try by filename
  7200. if not archive_id and filename:
  7201. result = await db.execute(
  7202. select(PrintArchive)
  7203. .where(PrintArchive.printer_id == printer_id)
  7204. .where(PrintArchive.filename == filename)
  7205. .where(PrintArchive.status == "printing")
  7206. .order_by(PrintArchive.created_at.desc())
  7207. .limit(1)
  7208. )
  7209. archive = result.scalar_one_or_none()
  7210. if archive:
  7211. archive_id = archive.id
  7212. await _cleanup_sd_card_after_print(printer_id, subtask_name, archive_id, logger)
  7213. log_timing("SD card cleanup")
  7214. # Update queue item status early — must run before the archive_id early-return
  7215. # so queue items don't get stuck in "printing" when archive lookup fails.
  7216. # Uses run_with_retry to handle SQLite "database is locked" errors (#897).
  7217. queue_item_id = None
  7218. billing_run_id: str | None = None
  7219. billing_user_id: int | None = None
  7220. billing_cost_center_id: int | None = None
  7221. billing_plate_id: int | None = None
  7222. queue_status = None
  7223. queue_auto_off = False
  7224. try:
  7225. from backend.app.core.database import run_with_retry
  7226. from backend.app.models.print_queue import PrintQueueItem
  7227. async def _update_queue_status(db):
  7228. nonlocal billing_run_id, billing_user_id, billing_cost_center_id, billing_plate_id
  7229. nonlocal queue_item_id, queue_status, queue_auto_off
  7230. result = await db.execute(
  7231. select(PrintQueueItem)
  7232. .where(PrintQueueItem.printer_id == printer_id)
  7233. .where(PrintQueueItem.status == "printing")
  7234. )
  7235. printing_items = list(result.scalars().all())
  7236. if len(printing_items) > 1:
  7237. logger.warning(
  7238. "BUG: Multiple queue items in 'printing' status for printer %s: %s",
  7239. printer_id,
  7240. [(i.id, i.archive_id, i.library_file_id) for i in printing_items],
  7241. )
  7242. item = printing_items[0] if printing_items else None
  7243. if item is not None and not await _completion_belongs_to_queue_item(db, item, data):
  7244. return
  7245. if item:
  7246. queue_status = data.get("status", "completed")
  7247. # MQTT sends "aborted" for cancelled prints; normalise to
  7248. # "cancelled" so it matches the queue schema Literal.
  7249. if queue_status == "aborted":
  7250. queue_status = "cancelled"
  7251. item.status = queue_status
  7252. item.completed_at = datetime.now(timezone.utc)
  7253. if queue_status == "failed" and not item.error_message:
  7254. item.error_message = _format_hms_error_summary(data.get("hms_errors") or [])
  7255. # Bump usage counters on the source library file so admins can
  7256. # sort by "last printed" and (eventually) auto-purge stale
  7257. # files — #1008.
  7258. await _bump_library_file_usage_if_completed(db, item, queue_status)
  7259. await db.commit()
  7260. queue_item_id = item.id
  7261. billing_run_id = item.billing_run_id
  7262. billing_user_id = item.created_by_id
  7263. billing_cost_center_id = item.cost_center_id
  7264. billing_plate_id = item.plate_id
  7265. queue_auto_off = item.auto_off_after
  7266. logger.info("Updated queue item %s status to %s", item.id, queue_status)
  7267. await run_with_retry(_update_queue_status, label="queue status update")
  7268. # Post-commit side effects (notifications, MQTT relay, auto-off) use
  7269. # their own sessions and have their own error handling — no retry needed.
  7270. if queue_item_id is not None:
  7271. # Batch orders (#342): this run may have been the last one an order
  7272. # owed. Re-evaluate here rather than lazily on read, so a finished
  7273. # order reports itself complete without someone opening the page.
  7274. try:
  7275. from backend.app.services.print_batch import refresh_batch_status_for_item
  7276. async with async_session() as db:
  7277. await refresh_batch_status_for_item(db, queue_item_id)
  7278. await db.commit()
  7279. except Exception as e:
  7280. logger.warning("[BATCH] Failed to refresh batch status for queue item %s: %s", queue_item_id, e)
  7281. # MQTT relay - publish queue job completed
  7282. try:
  7283. printer_info = printer_manager.get_printer(printer_id)
  7284. await mqtt_relay.on_queue_job_completed(
  7285. job_id=queue_item_id,
  7286. filename=filename or subtask_name,
  7287. printer_id=printer_id,
  7288. printer_name=printer_info.name if printer_info else "Unknown",
  7289. status=queue_status,
  7290. )
  7291. except Exception:
  7292. pass # Don't fail if MQTT fails
  7293. # Check if queue is now empty and send notification
  7294. try:
  7295. from sqlalchemy import func as sa_func
  7296. async with async_session() as db:
  7297. count_result = await db.execute(
  7298. select(sa_func.count(PrintQueueItem.id)).where(PrintQueueItem.status == "pending")
  7299. )
  7300. pending_count = count_result.scalar() or 0
  7301. if pending_count == 0:
  7302. today_start = datetime.now(timezone.utc).replace(hour=0, minute=0, second=0, microsecond=0)
  7303. completed_result = await db.execute(
  7304. select(sa_func.count(PrintQueueItem.id)).where(
  7305. PrintQueueItem.status.in_(["completed", "failed", "skipped"]),
  7306. PrintQueueItem.completed_at >= today_start,
  7307. )
  7308. )
  7309. completed_count = completed_result.scalar() or 1
  7310. await notification_service.on_queue_completed(
  7311. completed_count=completed_count,
  7312. db=db,
  7313. )
  7314. except Exception:
  7315. pass # Don't fail if notification fails
  7316. # Handle auto_off_after - power off printer if the queue item opted
  7317. # in. Delegates to the smart-plug manager so the off honours each
  7318. # plug's configured strategy (time delay or temperature threshold),
  7319. # is cancelled if the printer starts printing again, and never cuts
  7320. # power on a loaded print (#1890). Previously an inline block here
  7321. # hardcoded a 50°C / 600s cooldown wait and powered off on the
  7322. # timeout regardless of print state — cutting a touchscreen reprint.
  7323. if queue_auto_off:
  7324. try:
  7325. async with async_session() as db:
  7326. await smart_plug_manager.schedule_off_after_queue_job(printer_id, db)
  7327. except Exception as e:
  7328. logger.warning("Failed to schedule queue auto-off for printer %s: %s", printer_id, e)
  7329. except Exception as e:
  7330. logging.getLogger(__name__).warning(f"Queue item update failed: {e}")
  7331. log_timing("Queue item update")
  7332. # Register bed cooldown waiter (event-driven via on_bed_temp_update callback).
  7333. # Must run before archive_id early-return so it fires for all prints (including
  7334. # prints started from BambuStudio/touchscreen that have no archive).
  7335. if data.get("status") == "completed":
  7336. try:
  7337. from backend.app.api.routes.settings import get_setting
  7338. async with async_session() as db:
  7339. threshold_str = await get_setting(db, "bed_cooled_threshold")
  7340. threshold = float(threshold_str) if threshold_str else 35.0
  7341. # Check if any provider has on_bed_cooled enabled (skip registration if none)
  7342. async with async_session() as db:
  7343. providers = await notification_service._get_providers_for_event(db, "on_bed_cooled", printer_id)
  7344. if providers:
  7345. _bed_cool_waiters[printer_id] = {
  7346. "threshold": threshold,
  7347. "filename": filename or subtask_name or "",
  7348. "registered_at": time.time(),
  7349. }
  7350. logger.info(
  7351. "[BED-COOL] Registered waiter for printer %s (threshold: %.0f°C)",
  7352. printer_id,
  7353. threshold,
  7354. )
  7355. else:
  7356. logger.debug("[BED-COOL] No providers enabled for bed_cooled on printer %s", printer_id)
  7357. except Exception as e:
  7358. logger.warning("[BED-COOL] Failed to register waiter: %s", e)
  7359. # Capture the slicer estimate before usage tracking runs. The tracker may
  7360. # update archive.cost with this run's measured cost; billing partial runs
  7361. # against that already-partial value would discount the charge twice.
  7362. billing_planned_grams: float | None = None
  7363. billing_base_cost: float | None = None
  7364. if archive_id:
  7365. try:
  7366. async with async_session() as db:
  7367. from backend.app.models.archive import PrintArchive
  7368. billing_archive = await db.get(PrintArchive, archive_id)
  7369. if billing_archive:
  7370. billing_path = (
  7371. app_settings.base_dir / billing_archive.file_path if billing_archive.file_path else None
  7372. ) # SEC-PATH-OK: archive.file_path is DB-stored, internally generated
  7373. billing_planned_grams, billing_base_cost = _plate_scoped_run_estimate(
  7374. billing_archive,
  7375. billing_path,
  7376. billing_plate_id if billing_plate_id is not None else _get_start_plate_id(archive_id),
  7377. )
  7378. except Exception as e:
  7379. logger.warning("[FINANCE] Failed to capture planned usage for archive %s: %s", archive_id, e)
  7380. # --- Track filament consumption (must run before archive_id early-return so usage
  7381. # is recorded even when auto-archive is disabled) ---
  7382. usage_results: list[dict] = []
  7383. # Prefer ams_mapping captured from MQTT request topic (works for all print sources)
  7384. stored_ams_mapping = data.get("ams_mapping")
  7385. # Fallback to _print_ams_mappings for queue/reprint (set before print starts)
  7386. if not stored_ams_mapping and archive_id:
  7387. stored_ams_mapping = _print_ams_mappings.pop(archive_id, None)
  7388. # Always drain the plate_id register on completion — the session already
  7389. # consumed it at print-start injection; leaving it would leak into the next
  7390. # print on the same archive_id (rare but possible with reprints) (#1697).
  7391. # Capture the popped value so the completion notification can scope the
  7392. # archive-level (summed-across-plates per #1593) filament + time totals
  7393. # down to the single plate that was actually printed (#1785).
  7394. notify_plate_id: int | None = None
  7395. if archive_id:
  7396. notify_plate_id = _print_plate_ids.pop(archive_id, None)
  7397. # Internal inventory: track AMS remain% deltas (skip if Spoolman handles usage)
  7398. try:
  7399. async with async_session() as db:
  7400. from backend.app.api.routes.settings import get_setting
  7401. _spoolman_on = await get_setting(db, "spoolman_enabled")
  7402. if not _spoolman_on or _spoolman_on.lower() != "true":
  7403. from backend.app.services.usage_tracker import on_print_complete as usage_on_print_complete
  7404. async with async_session() as db:
  7405. usage_results = await usage_on_print_complete(
  7406. printer_id,
  7407. data,
  7408. printer_manager,
  7409. db,
  7410. archive_id=archive_id,
  7411. ams_mapping=stored_ams_mapping,
  7412. )
  7413. if usage_results:
  7414. await ws_manager.broadcast(
  7415. {
  7416. "type": "spool_usage_logged",
  7417. "printer_id": printer_id,
  7418. "usage": usage_results,
  7419. }
  7420. )
  7421. log_timing("Usage tracker")
  7422. except Exception as e:
  7423. logger.warning("Usage tracker on_print_complete failed: %s", e)
  7424. # Drop the print-start context unconditionally — the Spoolman branch above
  7425. # skips the internal tracker entirely, so nothing else would clear what
  7426. # print start captured, and a row surviving its print would be restored
  7427. # onto the next one after a restart.
  7428. try:
  7429. from backend.app.services.usage_tracker import discard_session
  7430. async with async_session() as db:
  7431. await discard_session(db, printer_id)
  7432. except Exception as e:
  7433. logger.warning("Failed to clear persisted print session for printer %s: %s", printer_id, e)
  7434. # Spoolman: report filament usage (requires archive_id for tracking data lookup)
  7435. # A partial run's cost from the Spoolman spools it was charged to; the
  7436. # built-in inventory's comes in usage_results.
  7437. spoolman_run_cost: float | None = None
  7438. if archive_id:
  7439. if data.get("status") == "completed":
  7440. try:
  7441. await _report_spoolman_usage(printer_id, archive_id)
  7442. log_timing("Spoolman usage report")
  7443. except Exception as e:
  7444. logger.warning("Spoolman usage reporting failed: %s", e)
  7445. else:
  7446. # Report partial usage if tracking data exists (only stored when weight sync is disabled)
  7447. try:
  7448. async with async_session() as db:
  7449. spoolman_run_cost = await _cleanup_spoolman_tracking(
  7450. printer_id,
  7451. archive_id,
  7452. db,
  7453. last_layer_num=data.get("last_layer_num"),
  7454. last_progress=data.get("last_progress"),
  7455. )
  7456. except Exception as e:
  7457. logger.debug("[SPOOLMAN] Cleanup failed: %s", e)
  7458. await _release_archived_spoolman_slots(printer_id)
  7459. log_timing("Filament usage tracking")
  7460. if not archive_id:
  7461. # The printer's own calibration run has no archive by design, so this
  7462. # arrives here every time one finishes. Returning before the no-archive
  7463. # notification keeps a calibration from being announced as a finished
  7464. # print. Everything above this point has already run — the plate-clear
  7465. # gate, the queue reconciliation, the SD-card cleanup — so only the
  7466. # notification is skipped.
  7467. if is_internal_printer_job(filename, subtask_name):
  7468. logger.info(
  7469. "[CALLBACK] Internal printer job completed, no notification: filename=%s, subtask=%s",
  7470. filename,
  7471. subtask_name,
  7472. )
  7473. return
  7474. logger.warning("Could not find archive for print complete: filename=%s, subtask=%s", filename, subtask_name)
  7475. # Still send print-complete/failed/stopped notifications even without an archive.
  7476. # Try to enrich with queue/library-file data so user-specific emails work too.
  7477. async def _notify_no_archive():
  7478. try:
  7479. async with async_session() as db:
  7480. from backend.app.models.library import LibraryFile
  7481. from backend.app.models.print_queue import PrintQueueItem
  7482. from backend.app.models.printer import Printer
  7483. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  7484. printer_obj = result.scalar_one_or_none()
  7485. p_name = printer_obj.name if printer_obj else f"Printer {printer_id}"
  7486. # Only the queue item this completion itself closed (the
  7487. # reconciliation above, which checks the run belongs to it).
  7488. # A print started outside Bambuddy closed none, and must not
  7489. # borrow an earlier job's owner, email or times.
  7490. no_archive_data: dict | None = None
  7491. try:
  7492. queue_item = await db.get(PrintQueueItem, queue_item_id) if queue_item_id else None
  7493. if queue_item:
  7494. no_archive_data = {"created_by_id": queue_item.created_by_id}
  7495. # How long it really ran, as the archive path reports it (#1198).
  7496. started = to_naive_utc(queue_item.started_at)
  7497. ended = to_naive_utc(queue_item.completed_at)
  7498. if started and ended and (ended - started).total_seconds() > 0:
  7499. no_archive_data["actual_time_seconds"] = int((ended - started).total_seconds())
  7500. # Estimated time: the queue item caches it from its
  7501. # archive or library file; otherwise read the library
  7502. # file's metadata (LibraryFile has no column for it).
  7503. if queue_item.print_time_seconds:
  7504. no_archive_data["print_time_seconds"] = queue_item.print_time_seconds
  7505. elif queue_item.library_file_id:
  7506. lib_result = await db.execute(
  7507. select(LibraryFile).where(LibraryFile.id == queue_item.library_file_id)
  7508. )
  7509. lib_file = lib_result.scalar_one_or_none()
  7510. estimate = (
  7511. (lib_file.file_metadata or {}).get("print_time_seconds") if lib_file else None
  7512. )
  7513. if estimate:
  7514. no_archive_data["print_time_seconds"] = estimate
  7515. except Exception as lookup_err:
  7516. logger.debug(
  7517. "[NOTIFY-BG] Could not look up queue item for no-archive notification: %s", lookup_err
  7518. )
  7519. # Enrich with usage tracker results (captured in enclosing scope)
  7520. if usage_results:
  7521. if no_archive_data is None:
  7522. no_archive_data = {}
  7523. total_from_usage = sum(r.get("weight_used", 0) for r in usage_results)
  7524. if total_from_usage > 0:
  7525. no_archive_data["actual_filament_grams"] = round(total_from_usage, 1)
  7526. no_archive_data["usage_results"] = usage_results
  7527. # Try MQTT remaining_time for print duration when no queue/library data
  7528. if no_archive_data and not no_archive_data.get("print_time_seconds"):
  7529. mqtt_remaining = data.get("remaining_time")
  7530. if mqtt_remaining and isinstance(mqtt_remaining, (int, float)) and mqtt_remaining > 0:
  7531. no_archive_data["print_time_seconds"] = int(mqtt_remaining)
  7532. ps = data.get("status", "completed")
  7533. logger.info(
  7534. "[NOTIFY-BG] Sending notification without archive: printer=%s, status=%s", printer_id, ps
  7535. )
  7536. if not await _kill_switch_notification_already_sent(kill_switch_notification_task):
  7537. await notification_service.on_print_complete(
  7538. printer_id, p_name, ps, data, db, archive_data=no_archive_data
  7539. )
  7540. else:
  7541. logger.info("[NOTIFY-BG] Skipped duplicate kill-switch provider notification")
  7542. # Send user-specific email if we have a created_by_id
  7543. if no_archive_data and no_archive_data.get("created_by_id"):
  7544. raw_filename = data.get("subtask_name") or data.get("filename", "Unknown")
  7545. await _dispatch_user_print_email(
  7546. ps,
  7547. no_archive_data["created_by_id"],
  7548. p_name,
  7549. raw_filename,
  7550. db,
  7551. )
  7552. logger.info("[NOTIFY-BG] Completed (no-archive path)")
  7553. except Exception as e:
  7554. logger.warning("[NOTIFY-BG] Failed to send notification without archive: %s", e, exc_info=True)
  7555. spawn_background_task(_notify_no_archive(), name="notify-no-archive")
  7556. return
  7557. log_timing("Archive lookup")
  7558. # Update archive status
  7559. logger.info("[ARCHIVE] Updating archive %s status...", archive_id)
  7560. try:
  7561. async with async_session() as db:
  7562. service = ArchiveService(db)
  7563. status = data.get("status", "completed")
  7564. hms_errors = data.get("hms_errors", []) if status == "failed" else None
  7565. if hms_errors:
  7566. logger.info("[ARCHIVE] HMS errors at failure: %s", hms_errors)
  7567. failure_reason = derive_failure_reason(status, hms_errors)
  7568. if data.get("_reconciled"):
  7569. # A reconciled completion closes out a stale archive at
  7570. # reconnect — it is not a user action, so don't mislabel it
  7571. # "userCancelled". It shares the stale-cleanup path's key
  7572. # (issue #2974) and records that the real end time is unknown,
  7573. # which is also why its logged duration is 0 (#2592).
  7574. failure_reason = "noStatusUpdate"
  7575. elif data.get("_kill_switch"):
  7576. # Not the user's cancel: the kill switch stopped a print that did
  7577. # not come from Bambuddy.
  7578. failure_reason = "killSwitch"
  7579. if failure_reason:
  7580. logger.info("[ARCHIVE] failure_reason=%r (status=%s)", failure_reason, status)
  7581. elif status == "failed" and hms_errors:
  7582. logger.info("[ARCHIVE] HMS errors present but none matched a known failure-reason short code")
  7583. await service.update_archive_status(
  7584. archive_id,
  7585. status=status,
  7586. completed_at=(
  7587. datetime.now(timezone.utc) if status in ("completed", "failed", "aborted", "cancelled") else None
  7588. ),
  7589. failure_reason=failure_reason,
  7590. )
  7591. logger.info(
  7592. "[ARCHIVE] Archive %s status updated to %s, failure_reason=%s", archive_id, status, failure_reason
  7593. )
  7594. await ws_manager.send_archive_updated(
  7595. {
  7596. "id": archive_id,
  7597. "status": status,
  7598. }
  7599. )
  7600. logger.info("[ARCHIVE] WebSocket notification sent for archive %s", archive_id)
  7601. # MQTT relay - publish archive updated
  7602. try:
  7603. await mqtt_relay.on_archive_updated(
  7604. archive_id=archive_id,
  7605. print_name=filename or subtask_name,
  7606. status=status,
  7607. )
  7608. except Exception:
  7609. pass # Don't fail if MQTT fails
  7610. except Exception as e:
  7611. logger.error("[ARCHIVE] Failed to update archive %s status: %s", archive_id, e, exc_info=True)
  7612. # Continue with other operations even if archive update fails
  7613. log_timing("Archive status update")
  7614. # Apply finance wallet charge or release reservations once. For all partial
  7615. # terminal states (failed, aborted at the printer display, or cancelled via
  7616. # Bambuddy) use this run's measured spool delta, falling back to the last
  7617. # valid printer progress. PrintArchive.filament_used_grams is the slicer
  7618. # estimate and therefore cannot represent an interrupted run.
  7619. try:
  7620. if data.get("status") in ("completed", "failed", "aborted", "cancelled"):
  7621. async with async_session() as db:
  7622. from backend.app.models.archive import PrintArchive
  7623. from backend.app.services.finance_billing import apply_print_charge_for_archive
  7624. archive = await db.get(PrintArchive, archive_id)
  7625. if archive and billing_run_id is None:
  7626. billing_run_id = getattr(archive, "billing_run_id", None)
  7627. if archive and archive.created_by_id is None and _print_user_info:
  7628. archive.created_by_id = await _print_user_id_if_still_there(db, _print_user_info)
  7629. await db.flush()
  7630. run_status = data.get("status", "completed")
  7631. last_progress = data.get("last_progress")
  7632. if last_progress is None:
  7633. last_progress = data.get("progress")
  7634. actual_run_grams = _compute_run_filament_grams(
  7635. run_status,
  7636. billing_planned_grams,
  7637. last_progress,
  7638. usage_results,
  7639. )
  7640. filament_usage = (actual_run_grams, billing_planned_grams) if run_status != "completed" else None
  7641. in_memory_cost_center_id = _print_cost_center_ids.pop(archive_id, None)
  7642. charged = await apply_print_charge_for_archive(
  7643. db,
  7644. archive_id,
  7645. charged_user_id=billing_user_id,
  7646. cost_center_id=(
  7647. billing_cost_center_id if billing_cost_center_id is not None else in_memory_cost_center_id
  7648. ),
  7649. print_queue_id=queue_item_id,
  7650. print_run_id=billing_run_id,
  7651. base_cost_override=billing_base_cost,
  7652. filament_usage=filament_usage,
  7653. )
  7654. await db.commit()
  7655. if charged:
  7656. logger.info("[FINANCE] Applied print charge for archive %s", archive_id)
  7657. except Exception as e:
  7658. logger.warning("[FINANCE] Failed to apply print charge for archive %s: %s", archive_id, e)
  7659. printer_info = printer_manager.get_printer(printer_id)
  7660. billing_printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
  7661. billing_filename = filename or subtask_name or "Unknown"
  7662. billing_error = str(e)
  7663. try:
  7664. await ws_manager.broadcast(
  7665. {
  7666. "type": "billing_charge_failed",
  7667. "printer_id": printer_id,
  7668. "printer_name": billing_printer_name,
  7669. "filename": billing_filename,
  7670. "archive_id": archive_id,
  7671. }
  7672. )
  7673. except Exception as notification_error:
  7674. logger.error(
  7675. "[FINANCE] Failed to broadcast billing error for archive %s: %s",
  7676. archive_id,
  7677. notification_error,
  7678. )
  7679. async def _notify_billing_charge_failed() -> None:
  7680. try:
  7681. async with async_session() as notification_db:
  7682. await notification_service.on_billing_charge_failed(
  7683. printer_id,
  7684. billing_printer_name,
  7685. billing_filename,
  7686. archive_id,
  7687. billing_error,
  7688. notification_db,
  7689. )
  7690. except Exception as provider_error:
  7691. logger.error(
  7692. "[FINANCE] Failed to send provider billing alert for archive %s: %s",
  7693. archive_id,
  7694. provider_error,
  7695. exc_info=True,
  7696. )
  7697. spawn_background_task(
  7698. _notify_billing_charge_failed(),
  7699. name=f"billing-charge-failed-{archive_id}",
  7700. )
  7701. log_timing("Finance charge update")
  7702. # Write independent print log entry (separate table, never touches archives)
  7703. try:
  7704. async with async_session() as db:
  7705. from backend.app.models.archive import PrintArchive
  7706. from backend.app.services.print_log import record_archive_wear, write_log_entry
  7707. archive = await db.get(PrintArchive, archive_id)
  7708. if archive:
  7709. # Back-fill created_by_id on reprint (#730): reprint reuses the
  7710. # source archive row rather than creating a new one, so an
  7711. # archive that was auto-created from a printer-initiated
  7712. # print (created_by_id=NULL) would otherwise stay unattributed
  7713. # forever. When we have a print-session user AND the archive
  7714. # has no attribution yet, credit the current user. Never
  7715. # overwrite an existing attribution — the original uploader
  7716. # keeps ownership.
  7717. _print_user_id = await _print_user_id_if_still_there(db, _print_user_info)
  7718. if archive.created_by_id is None and _print_user_id is not None:
  7719. archive.created_by_id = _print_user_id
  7720. p_info = printer_manager.get_printer(printer_id)
  7721. # Per-run actuals — written to PrintLogEntry so stats reflect
  7722. # what THIS print actually used, not the source archive's
  7723. # first-run values (#1378). Helper handles the partial-print
  7724. # math (failed / cancelled / stopped get scaled to progress
  7725. # or to tracked spool deltas).
  7726. _run_status = data.get("status", "completed")
  7727. # #2614: scope the per-run estimate to the printed plate. For a
  7728. # multi-plate 3MF dispatched one plate at a time, the archive's
  7729. # filament/cost are the whole-file totals; the PrintLogEntry must
  7730. # reflect only this plate. No effect on single-plate archives (the
  7731. # plate estimate equals the whole-file value) or on the tracker
  7732. # path (measured spool deltas win in _compute_run_filament_grams).
  7733. _est_full_path = (
  7734. app_settings.base_dir / archive.file_path if archive.file_path else None
  7735. ) # SEC-PATH-OK: archive.file_path is DB-stored, internally generated
  7736. # The plate that printed, as billing reads it: a reprint of
  7737. # another plate must not log the archive's first plate.
  7738. _est_grams, _est_cost = _plate_scoped_run_estimate(
  7739. archive,
  7740. _est_full_path,
  7741. billing_plate_id if billing_plate_id is not None else notify_plate_id,
  7742. )
  7743. _run_grams = _compute_run_filament_grams(
  7744. _run_status,
  7745. _est_grams,
  7746. data.get("last_progress", data.get("progress")),
  7747. usage_results,
  7748. )
  7749. # Per-run cost — prefer usage_results sum. For partial prints
  7750. # we deliberately skip the topup-to-estimate logic in
  7751. # usage_tracker (which assumes the print completed); the raw
  7752. # tracked-spool sum is closer to what THIS run actually cost.
  7753. _run_cost: float | None = None
  7754. if usage_results:
  7755. _run_cost = sum(r.get("cost") or 0 for r in usage_results) or None
  7756. if _run_cost is None and _run_status != "completed":
  7757. _run_cost = spoolman_run_cost
  7758. if _run_cost is None and _run_status == "completed":
  7759. _run_cost = _est_cost
  7760. from backend.app.models.printer import Printer as _Printer
  7761. _wear_rate = await db.scalar(select(_Printer.wear_cost_per_hour).where(_Printer.id == printer_id))
  7762. run_entry = await write_log_entry(
  7763. db,
  7764. archive_id=archive.id,
  7765. # Captured by _update_queue_status above; None for
  7766. # printer-initiated prints with no queue row. Batch
  7767. # cost/energy roll-up joins on it (#342).
  7768. queue_item_id=queue_item_id,
  7769. status=_run_status,
  7770. print_name=archive.print_name,
  7771. printer_name=p_info.name if p_info else None,
  7772. printer_id=printer_id,
  7773. started_at=archive.started_at,
  7774. completed_at=archive.completed_at,
  7775. filament_type=archive.filament_type,
  7776. filament_color=archive.filament_color,
  7777. filament_used_grams=_run_grams,
  7778. cost=_run_cost,
  7779. wear_cost_per_hour=_wear_rate,
  7780. failure_reason=archive.failure_reason,
  7781. thumbnail_path=archive.thumbnail_path,
  7782. created_by_id=archive.created_by_id,
  7783. created_by_username=_print_user_info.get("username") if _print_user_info else None,
  7784. # Reconciled completions have an unknown real end time —
  7785. # log 0 duration instead of the whole disconnect gap (#2592).
  7786. reconciled=bool(data.get("_reconciled")),
  7787. )
  7788. await record_archive_wear(db, archive, run_entry)
  7789. await db.commit()
  7790. logger.info("[PRINT_LOG] Log entry written for archive %s", archive_id)
  7791. except Exception as e:
  7792. logger.warning("[PRINT_LOG] Failed to write log entry for archive %s: %s", archive_id, e)
  7793. log_timing("Print log entry")
  7794. # Run slow operations as background tasks to avoid blocking the event loop
  7795. # These operations can take 5-10+ seconds and would freeze the UI if awaited
  7796. async def _background_energy_calculation():
  7797. """Calculate and save energy usage in background.
  7798. Reads the starting kWh from the archive row (#941: persisted so a mid-print
  7799. backend restart no longer loses per-print energy data).
  7800. """
  7801. try:
  7802. logger.info("[ENERGY-BG] Starting energy calculation for archive %s", archive_id)
  7803. async with async_session() as db:
  7804. from backend.app.models.archive import PrintArchive
  7805. archive = await db.get(PrintArchive, archive_id)
  7806. if archive is None:
  7807. logger.warning("[ENERGY-BG] Archive %s no longer exists", archive_id)
  7808. return
  7809. starting_kwh = archive.energy_start_kwh
  7810. if starting_kwh is None:
  7811. logger.info("[ENERGY-BG] No start kWh recorded for archive %s", archive_id)
  7812. return
  7813. candidates = await energy_plug_candidates(db, printer_id)
  7814. if not candidates:
  7815. logger.info("[ENERGY-BG] No smart plug for printer %s", printer_id)
  7816. return
  7817. # Same ordering as the start reading, so the delta below is
  7818. # against the counter that produced `starting_kwh` (#2859).
  7819. selected = await select_energy_reading(candidates, _get_plug_energy, db)
  7820. if selected is None:
  7821. logger.warning(
  7822. "[ENERGY-BG] No plug on printer %s reports a lifetime energy counter (tried: %s)",
  7823. printer_id,
  7824. ", ".join(plug.name for plug in candidates),
  7825. )
  7826. return
  7827. plug, energy = selected
  7828. logger.info("[ENERGY-BG] Energy response from plug '%s': %s", plug.name, energy)
  7829. energy_used = round(energy["total"] - starting_kwh, 4)
  7830. logger.info("[ENERGY-BG] Per-print energy: %s kWh", energy_used)
  7831. if energy_used < 0:
  7832. logger.warning(
  7833. "[ENERGY-BG] Negative energy delta for archive %s (start=%s, end=%s) — counter reset?",
  7834. archive_id,
  7835. starting_kwh,
  7836. energy["total"],
  7837. )
  7838. return
  7839. from backend.app.services.energy_price import current_price, print_energy_cost, stored_price
  7840. # Each hour of the print at the price of that hour (#1251). If
  7841. # that fails, the last price known, as before, rather than no
  7842. # energy at all. Read first: the session may be unusable after.
  7843. last_price = await stored_price(db)
  7844. try:
  7845. energy_cost_value = round(
  7846. await print_energy_cost(
  7847. db,
  7848. plug_id=archive.energy_start_plug_id,
  7849. start_at=archive.energy_start_at,
  7850. start_kwh=starting_kwh,
  7851. start_price=archive.energy_start_price,
  7852. end_kwh=energy["total"],
  7853. end_plug_id=plug.id,
  7854. price_now=await current_price(db),
  7855. ),
  7856. 3,
  7857. )
  7858. except Exception as e:
  7859. logger.warning("[ENERGY-BG] Hour-by-hour cost failed for archive %s: %s", archive_id, e)
  7860. energy_cost_value = round(energy_used * last_price, 3)
  7861. # First-run-only overwrite of archive.energy_kwh / energy_cost so a
  7862. # reprint doesn't visually clobber the source archive's energy data
  7863. # (#1378). Reprint energy lives in the matching PrintLogEntry below.
  7864. from sqlalchemy import func
  7865. from backend.app.models.print_log import PrintLogEntry
  7866. existing_runs = await db.scalar(
  7867. select(func.count(PrintLogEntry.id)).where(PrintLogEntry.archive_id == archive_id)
  7868. )
  7869. if (existing_runs or 0) <= 1:
  7870. # 0 = legacy archive that pre-dates per-run logging; 1 = the row
  7871. # we just wrote for THIS print. Either way it's the first run.
  7872. archive.energy_kwh = energy_used
  7873. archive.energy_cost = energy_cost_value
  7874. # Backfill the latest PrintLogEntry for this archive with energy
  7875. # (write_log_entry above ran before this background task completed,
  7876. # so energy fields are still NULL on that row).
  7877. latest_run = await db.execute(
  7878. select(PrintLogEntry)
  7879. .where(PrintLogEntry.archive_id == archive_id)
  7880. .order_by(PrintLogEntry.id.desc())
  7881. .limit(1)
  7882. )
  7883. run_row = latest_run.scalar_one_or_none()
  7884. if run_row is not None:
  7885. run_row.energy_kwh = energy_used
  7886. run_row.energy_cost = energy_cost_value
  7887. await db.commit()
  7888. logger.info("[ENERGY-BG] Saved: %s kWh, cost=%s", energy_used, energy_cost_value)
  7889. except Exception as e:
  7890. logger.warning("[ENERGY-BG] Failed: %s", e)
  7891. async def _background_finish_photo() -> str | None:
  7892. """Capture finish photo in background. Returns photo filename if captured."""
  7893. # #2547: set once this function has raised the plate itself (the
  7894. # timelapse path, where the moment producer returned without doing it).
  7895. # Declared out here so the `finally` can lower it again no matter where
  7896. # the capture below fails.
  7897. plate_restored_z: float | None = None
  7898. try:
  7899. logger.info("[PHOTO-BG] Starting finish photo capture for archive %s", archive_id)
  7900. from backend.app.api.routes.camera import _active_chamber_streams, _active_streams, get_buffered_frame
  7901. # Read phase: settings + printer + archive in a short session, released
  7902. # BEFORE the capture pipeline below. The capture (timelapse last-frame,
  7903. # stage-22 wait, external-camera grab, or a fresh RTSP shot) can take
  7904. # tens of seconds; holding this session across it pinned one pooled
  7905. # connection idle-in-transaction per finishing print (issue #2572).
  7906. async with async_session() as db:
  7907. from backend.app.api.routes.settings import get_setting
  7908. from backend.app.models.archive import PrintArchive
  7909. from backend.app.models.printer import Printer
  7910. capture_enabled = await get_setting(db, "capture_finish_photo")
  7911. if capture_enabled is not None and capture_enabled.lower() != "true":
  7912. return None
  7913. if not archive_id:
  7914. return None
  7915. printer = (await db.execute(select(Printer).where(Printer.id == printer_id))).scalar_one_or_none()
  7916. archive = (
  7917. await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  7918. ).scalar_one_or_none()
  7919. if not printer or not archive:
  7920. return None
  7921. import uuid
  7922. from datetime import datetime
  7923. from backend.app.utils.archive_paths import archive_dir as resolve_archive_dir
  7924. if not archive.file_path:
  7925. logger.warning("[PHOTO-BG] Archive %s has no file_path, using fallback dir", archive_id)
  7926. archive_dir = resolve_archive_dir(archive)
  7927. photo_filename = None
  7928. # Prefer the timelapse last-frame source when a timelapse was
  7929. # recording — it captures the moment after the toolhead parks
  7930. # but before the bed drops, which the live-camera grab below
  7931. # would miss (#1397). Skipped for external cameras (those have
  7932. # their own framing and don't see a Bambu timelapse). Only
  7933. # runs when the USER explicitly enabled timelapse for this
  7934. # print — #1721 removed Bambuddy's force-on at dispatch
  7935. # because it caused per-layer nozzle parking on Smooth-mode
  7936. # slicer profiles.
  7937. prefer_timelapse_source = bool(data.get("timelapse_was_active")) and not (
  7938. printer.external_camera_enabled and printer.external_camera_url
  7939. )
  7940. timelapse_still_pending = False
  7941. if prefer_timelapse_source:
  7942. photo_filename, timelapse_still_pending = await _capture_finish_photo_from_timelapse(
  7943. archive_id=archive_id,
  7944. archive_dir=archive_dir,
  7945. rotation=getattr(printer, "camera_rotation", 0),
  7946. )
  7947. # #1721: replacement framing path — on_finish_photo_moment
  7948. # pre-captured a frame at the stage-22 / FINISH edge (toolhead
  7949. # parked, bed not yet dropped) and cached the JPEG bytes in
  7950. # _stage22_finish_frames. Consume them now so the saved photo
  7951. # has the better framing instead of the post-bed-drop angle
  7952. # the live-camera fallback below would give.
  7953. if not photo_filename:
  7954. # #1790: on the FINISH-state fallback path the producer
  7955. # task is dispatched back-to-back with this consumer, so
  7956. # a bare pop would race past with an empty result and
  7957. # the RTSP fallback below would collide with the
  7958. # producer's still-in-flight grab (single-client RTSP
  7959. # on Bambu printers). Wait for the producer to finish
  7960. # or give up before touching the cache.
  7961. #
  7962. # #2547: 20s was enough when the producer only ever grabbed a
  7963. # frame. It now also raises the plate first, which costs the
  7964. # settle window before the grab even starts — so the budget has
  7965. # to cover settle + a worst-case 15s RTSP timeout, and still sit
  7966. # under the notification's own photo wait below.
  7967. in_flight = _stage22_finish_in_flight.pop(printer_id, None)
  7968. if in_flight is not None:
  7969. try:
  7970. await asyncio.wait_for(in_flight.wait(), timeout=_FINISH_PHOTO_PRODUCER_WAIT_SECONDS)
  7971. except TimeoutError:
  7972. logger.warning(
  7973. "[PHOTO-BG] timed out waiting for stage-22 producer for printer %s — proceeding to fallback",
  7974. printer_id,
  7975. )
  7976. cached_frame = _stage22_finish_frames.pop(printer_id, None)
  7977. if cached_frame:
  7978. # Already rotated by the producer (#2708) — rotating again
  7979. # here would undo the fix on the banked-frame path, whose
  7980. # bytes reach the cache having been rotated once already.
  7981. photos_dir = archive_dir / "photos"
  7982. photos_dir.mkdir(parents=True, exist_ok=True)
  7983. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  7984. photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  7985. photo_path = photos_dir / photo_filename
  7986. await asyncio.to_thread(photo_path.write_bytes, cached_frame)
  7987. logger.info(
  7988. "[PHOTO-BG] Saved stage-22 pre-captured frame: %s (%d bytes)",
  7989. photo_filename,
  7990. len(cached_frame),
  7991. )
  7992. # #2547: the timelapse path reaches the live grab below whenever the
  7993. # video hasn't landed in time — the documented usual outcome on
  7994. # P1-series, where transfers are slowest. `on_finish_photo_moment`
  7995. # returned early for those prints without raising the plate, so
  7996. # without this the photo that actually ships in the notification is
  7997. # of an already-dropped plate: exactly the framing #1145/#1397/#1565
  7998. # asked us to fix. The archive still gets the better video frame
  7999. # later; this is about the image the user is sent.
  8000. #
  8001. # Gated on `timelapse_was_active` precisely because that is the
  8002. # condition under which the producer skipped. On every other path it
  8003. # has already raised and lowered the plate, and repeating that here
  8004. # would be a second pointless round trip.
  8005. if (
  8006. not photo_filename
  8007. and data.get("timelapse_was_active")
  8008. and not print_dispatch_context.end_gcode_injected(printer_id)
  8009. ):
  8010. try:
  8011. async with async_session() as db:
  8012. from backend.app.api.routes.settings import get_setting
  8013. restore_setting = await get_setting(db, "finish_photo_restore_plate")
  8014. if restore_setting is None or restore_setting.lower() == "true":
  8015. max_z = await _max_z_for_current_print(
  8016. printer_id, data, logger, bound_archive_id, notify_plate_id
  8017. )
  8018. if max_z is not None and not await _plate_restore_is_blocked_by_queue(printer_id):
  8019. if await _restore_plate_for_finish_photo(printer_id, max_z, logger):
  8020. plate_restored_z = max_z
  8021. except Exception as e:
  8022. logger.warning("[PLATE-RESTORE] printer %s: restore failed: %s", printer_id, e)
  8023. # Fallback chain: external camera → buffered live frame →
  8024. # fresh RTSP capture. Only runs if the timelapse path above
  8025. # didn't already produce a photo.
  8026. # Chamber light for the live capture below (#1655).
  8027. async with camera_light(printer if not photo_filename else None):
  8028. if not photo_filename:
  8029. if printer.external_camera_enabled and printer.external_camera_url:
  8030. logger.info("[PHOTO-BG] Using external camera")
  8031. from backend.app.api.routes.camera import live_frame_for_capture
  8032. from backend.app.services.external_camera import capture_frame
  8033. # #2707: the second half of the finish-photo failure — the
  8034. # pre-capture and this fallback both collided with the live
  8035. # view. None here continues down the fallback chain.
  8036. defer, buffered = live_frame_for_capture(printer_id)
  8037. if defer:
  8038. frame_data = buffered
  8039. else:
  8040. frame_data = await capture_frame(
  8041. printer.external_camera_url,
  8042. printer.external_camera_type or "mjpeg",
  8043. snapshot_url=printer.external_camera_snapshot_url,
  8044. )
  8045. if frame_data:
  8046. frame_data = _apply_camera_rotation(frame_data, printer, logger)
  8047. photos_dir = archive_dir / "photos"
  8048. photos_dir.mkdir(parents=True, exist_ok=True)
  8049. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  8050. photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  8051. photo_path = photos_dir / photo_filename
  8052. await asyncio.to_thread(photo_path.write_bytes, frame_data)
  8053. logger.info("[PHOTO-BG] Saved external camera frame: %s", photo_filename)
  8054. else:
  8055. # Check if camera stream is active - use buffered frame to avoid freeze
  8056. # Check both RTSP streams (_active_streams) and chamber image streams (_active_chamber_streams)
  8057. active_for_printer = [k for k in _active_streams if k.startswith(f"{printer_id}-")]
  8058. active_chamber_for_printer = [
  8059. k for k in _active_chamber_streams if k.startswith(f"{printer_id}-")
  8060. ]
  8061. buffered_frame = get_buffered_frame(printer_id)
  8062. if (active_for_printer or active_chamber_for_printer) and buffered_frame:
  8063. # Use frame from active stream
  8064. logger.info("[PHOTO-BG] Using buffered frame from active stream")
  8065. buffered_frame = _apply_camera_rotation(buffered_frame, printer, logger)
  8066. photos_dir = archive_dir / "photos"
  8067. photos_dir.mkdir(parents=True, exist_ok=True)
  8068. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  8069. photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  8070. photo_path = photos_dir / photo_filename
  8071. await asyncio.to_thread(photo_path.write_bytes, buffered_frame)
  8072. logger.info("[PHOTO-BG] Saved buffered frame: %s", photo_filename)
  8073. else:
  8074. # No active stream - capture new frame
  8075. from backend.app.services.camera import capture_finish_photo
  8076. photo_filename = await capture_finish_photo(
  8077. printer_id=printer_id,
  8078. ip_address=printer.ip_address,
  8079. access_code=printer.access_code,
  8080. model=printer.model,
  8081. archive_dir=archive_dir,
  8082. rotation=getattr(printer, "camera_rotation", 0),
  8083. )
  8084. # Write phase: attach the photo in a fresh short-lived session.
  8085. if photo_filename:
  8086. async with async_session() as db:
  8087. from backend.app.models.archive import PrintArchive
  8088. arch = await db.get(PrintArchive, archive_id)
  8089. if arch is not None:
  8090. photos = arch.photos or []
  8091. photos.append(photo_filename)
  8092. arch.photos = photos
  8093. await db.commit()
  8094. logger.info("[PHOTO-BG] Saved: %s", photo_filename)
  8095. # The short wait above is bounded so a slow printer can't hold up
  8096. # the print-complete notification, which is what the caller is
  8097. # blocking on. When it ran out with the video still on its way,
  8098. # keep waiting off to the side and add the better frame to the
  8099. # archive once it arrives (#2704 follow-up) — otherwise P1-series
  8100. # users, whose videos routinely take minutes to transfer, never get
  8101. # the pre-bed-drop framing this path exists to provide.
  8102. #
  8103. # Spawned here rather than at the point the wait gave up: both this
  8104. # function and the upgrade do a read-modify-write on `photos`, and
  8105. # the live-camera fallback above can take tens of seconds. Starting
  8106. # the upgrade before that write means the two can interleave and one
  8107. # silently drops the other's entry, leaving a JPEG on disk that the
  8108. # gallery never lists.
  8109. if timelapse_still_pending:
  8110. spawn_background_task(
  8111. _upgrade_finish_photo_from_timelapse(
  8112. archive_id, archive_dir, rotation=getattr(printer, "camera_rotation", 0)
  8113. ),
  8114. name=f"finish-photo-upgrade-{archive_id}",
  8115. )
  8116. return photo_filename
  8117. except Exception as e:
  8118. logger.warning("[PHOTO-BG] Failed: %s", e)
  8119. return None
  8120. finally:
  8121. # #2547: we raised the plate, so we owe the move back down — even if
  8122. # the capture in between threw. Otherwise the user finds the print
  8123. # pinned under the nozzle.
  8124. if plate_restored_z is not None:
  8125. try:
  8126. _park_plate_after_finish_photo(printer_id, plate_restored_z, logger)
  8127. except Exception as e:
  8128. logger.warning("[PLATE-RESTORE] printer %s: could not lower plate: %s", printer_id, e)
  8129. spawn_background_task(_background_energy_calculation(), name="background-energy-calc")
  8130. # Photo capture task - result will be used by notifications
  8131. photo_task = spawn_background_task(_background_finish_photo(), name="background-finish-photo")
  8132. log_timing("Background tasks scheduled (energy, photo)")
  8133. # Also run smart plug, notifications, and maintenance as background tasks
  8134. print_status = data.get("status", "completed")
  8135. async def _background_smart_plug():
  8136. """Handle smart plug automation in background."""
  8137. try:
  8138. logger.info("[AUTO-OFF-BG] Starting smart plug automation for printer %s", printer_id)
  8139. async with async_session() as db:
  8140. await smart_plug_manager.on_print_complete(printer_id, print_status, db)
  8141. logger.info("[AUTO-OFF-BG] Completed")
  8142. except Exception as e:
  8143. logger.warning("[AUTO-OFF-BG] Failed: %s", e)
  8144. async def _background_notifications(finish_photo_filename: str | None = None):
  8145. """Send print complete notifications in background."""
  8146. try:
  8147. logger.info(
  8148. "[NOTIFY-BG] Starting notifications for printer %s, photo=%s", printer_id, finish_photo_filename
  8149. )
  8150. async with async_session() as db:
  8151. from backend.app.models.archive import PrintArchive
  8152. from backend.app.models.printer import Printer
  8153. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  8154. printer = result.scalar_one_or_none()
  8155. printer_name = printer.name if printer else f"Printer {printer_id}"
  8156. archive_data = None
  8157. if archive_id:
  8158. archive_result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  8159. archive = archive_result.scalar_one_or_none()
  8160. if archive:
  8161. # Actual elapsed time from started_at/completed_at when both are
  8162. # populated (every terminal status sets completed_at after #1198).
  8163. # Falls back to None so the notification path can decide whether to
  8164. # render the slicer estimate as a last resort.
  8165. actual_time_seconds = None
  8166. if archive.started_at and archive.completed_at:
  8167. elapsed = (archive.completed_at - archive.started_at).total_seconds()
  8168. if elapsed > 0:
  8169. actual_time_seconds = int(elapsed)
  8170. archive_data = {
  8171. "print_time_seconds": archive.print_time_seconds,
  8172. "actual_time_seconds": actual_time_seconds,
  8173. "actual_filament_grams": archive.filament_used_grams,
  8174. "failure_reason": archive.failure_reason,
  8175. "created_by_id": archive.created_by_id,
  8176. }
  8177. # Scale filament usage for partial prints
  8178. if print_status != "completed" and archive.filament_used_grams:
  8179. progress = data.get("progress") or 0
  8180. scale = _partial_progress_scale(progress)
  8181. archive_data["actual_filament_grams"] = round(archive.filament_used_grams * scale, 1)
  8182. archive_data["progress"] = progress
  8183. # Pass per-slot data from archive.extra_data
  8184. if archive.extra_data and archive.extra_data.get("filament_slots"):
  8185. slots = archive.extra_data["filament_slots"]
  8186. if print_status != "completed":
  8187. scale = _partial_progress_scale(data.get("progress"))
  8188. slots = [{**s, "used_g": round(s["used_g"] * scale, 1)} for s in slots]
  8189. archive_data["filament_slots"] = slots
  8190. # Scope project-summed totals down to the plate that was
  8191. # actually printed — see _scope_notification_archive_data_to_plate
  8192. # for the why (#1785).
  8193. archive_data = _scope_notification_archive_data_to_plate(
  8194. archive_data,
  8195. archive.file_path,
  8196. notify_plate_id,
  8197. print_status,
  8198. data.get("progress"),
  8199. app_settings.base_dir,
  8200. )
  8201. # Enrich filament_grams from usage_results when archive has no 3MF data
  8202. if not archive_data.get("actual_filament_grams") and usage_results:
  8203. total_from_usage = sum(r.get("weight_used", 0) for r in usage_results)
  8204. if total_from_usage > 0:
  8205. archive_data["actual_filament_grams"] = round(total_from_usage, 1)
  8206. # Pass usage tracker results for AMS slot info in notifications
  8207. if usage_results:
  8208. archive_data["usage_results"] = usage_results
  8209. # Add finish photo URL and image bytes if available
  8210. if finish_photo_filename:
  8211. photo_url, photo_bytes = await _finish_photo_for_notification(
  8212. db, archive, archive_id, finish_photo_filename
  8213. )
  8214. if photo_url:
  8215. archive_data["finish_photo_url"] = photo_url
  8216. if photo_bytes:
  8217. archive_data["image_data"] = photo_bytes
  8218. if not await _kill_switch_notification_already_sent(kill_switch_notification_task):
  8219. await notification_service.on_print_complete(
  8220. printer_id, printer_name, print_status, data, db, archive_data=archive_data
  8221. )
  8222. else:
  8223. logger.info("[NOTIFY-BG] Skipped duplicate kill-switch provider notification")
  8224. # Post-print outcome confirmation (#1898). Runs in this
  8225. # background task so the finish photo fetched above rides
  8226. # along with the prompt.
  8227. if print_status == "completed" and archive_id:
  8228. await _dispatch_outcome_confirmation_safely(
  8229. db, printer_id, printer_name, data, archive_id, archive_data
  8230. )
  8231. # Send user-specific email notification
  8232. if archive_data:
  8233. created_by_id = archive_data.get("created_by_id")
  8234. raw_filename = data.get("subtask_name") or data.get("filename", "Unknown")
  8235. await _dispatch_user_print_email(
  8236. print_status,
  8237. created_by_id,
  8238. printer_name,
  8239. raw_filename,
  8240. db,
  8241. image_data=archive_data.get("image_data"),
  8242. finish_photo_url=archive_data.get("finish_photo_url"),
  8243. )
  8244. logger.info("[NOTIFY-BG] Completed")
  8245. except Exception as e:
  8246. logger.error("[NOTIFY-BG] Failed: %s", e, exc_info=True)
  8247. async def _background_maintenance_check():
  8248. """Check for maintenance due in background."""
  8249. if print_status != "completed":
  8250. return
  8251. try:
  8252. logger.info("[MAINT-BG] Starting maintenance check for printer %s", printer_id)
  8253. async with async_session() as db:
  8254. from backend.app.models.printer import Printer
  8255. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  8256. printer = result.scalar_one_or_none()
  8257. printer_name = printer.name if printer else f"Printer {printer_id}"
  8258. await ensure_default_types(db)
  8259. overview = await _get_printer_maintenance_internal(printer_id, db, commit=True)
  8260. attention = [
  8261. item for item in overview.maintenance_items if item.enabled and (item.is_due or item.is_warning)
  8262. ]
  8263. items_needing_attention = [
  8264. {"name": item.maintenance_type_name, "is_due": item.is_due, "is_warning": item.is_warning}
  8265. for item in attention
  8266. ]
  8267. if items_needing_attention:
  8268. await notification_service.on_maintenance_due(printer_id, printer_name, items_needing_attention, db)
  8269. logger.info("[MAINT-BG] Sent notification: %s items need attention", len(items_needing_attention))
  8270. # MQTT relay - publish maintenance alerts
  8271. for item in attention:
  8272. current_value, threshold, unit = maintenance_alert_values(item)
  8273. try:
  8274. await mqtt_relay.on_maintenance_alert(
  8275. printer_id=printer_id,
  8276. printer_name=printer_name,
  8277. maintenance_type=item.maintenance_type_name,
  8278. current_value=current_value,
  8279. threshold=threshold,
  8280. unit=unit,
  8281. )
  8282. except Exception:
  8283. pass # Don't fail if MQTT fails
  8284. else:
  8285. logger.info("[MAINT-BG] Completed (no items need attention)")
  8286. except Exception as e:
  8287. logger.warning("[MAINT-BG] Failed: %s", e)
  8288. spawn_background_task(_background_smart_plug(), name="background-smart-plug")
  8289. spawn_background_task(_background_maintenance_check(), name="background-maintenance-check")
  8290. # Notification task waits for photo capture to complete first (with timeout).
  8291. # When a timelapse was recording, photo sourcing polls the per-print
  8292. # timelapse for up to 60s (#1397) — extend the budget so the notification
  8293. # carries the correct bed-up photo instead of falling through to the
  8294. # live-cam grab. Adds ~30s of notification latency at worst on slow links.
  8295. #
  8296. # #2547: both budgets now have to cover a plate restore as well.
  8297. #
  8298. # Without timelapse, the wait is on the moment producer, which raises the
  8299. # plate before its grab — so this has to outlast that producer's own budget.
  8300. #
  8301. # With timelapse, the capture polls up to
  8302. # `_FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS` for the video and only then
  8303. # falls back to a live grab, which is the case that raises the plate. At the
  8304. # old flat 75s that fallback was guaranteed to be cut off mid-settle, so the
  8305. # restore would have moved the plate for a photo nobody waited for.
  8306. photo_wait_timeout = (
  8307. _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS + _FINISH_PHOTO_PRODUCER_WAIT_SECONDS
  8308. if data.get("timelapse_was_active")
  8309. else _FINISH_PHOTO_PRODUCER_WAIT_SECONDS + 15
  8310. )
  8311. async def _photo_then_notify():
  8312. """Wait for photo capture, then send notification with photo URL."""
  8313. finish_photo = None
  8314. try:
  8315. finish_photo = await asyncio.wait_for(photo_task, timeout=photo_wait_timeout)
  8316. logger.info("[PHOTO-NOTIFY] Photo task returned: %s", finish_photo)
  8317. except TimeoutError:
  8318. logger.warning(
  8319. "[PHOTO-NOTIFY] Photo capture timed out after %ss, sending notification without photo",
  8320. photo_wait_timeout,
  8321. )
  8322. except Exception as e:
  8323. logger.warning("[PHOTO-NOTIFY] Photo task failed: %s", e)
  8324. try:
  8325. await _background_notifications(finish_photo)
  8326. except Exception as e:
  8327. logger.error("[PHOTO-NOTIFY] Notification sending failed: %s", e, exc_info=True)
  8328. spawn_background_task(_photo_then_notify(), name="photo-then-notify")
  8329. # Stitch external camera layer timelapse if session was active
  8330. print_status = data.get("status", "completed")
  8331. async def _background_layer_timelapse():
  8332. """Stitch layer timelapse and attach to archive."""
  8333. from backend.app.services.layer_timelapse import cancel_session, on_print_complete as tl_complete
  8334. try:
  8335. if print_status == "completed":
  8336. logger.info("[LAYER-TL] Stitching layer timelapse for printer %s", printer_id)
  8337. timelapse_path = await tl_complete(printer_id)
  8338. if timelapse_path and archive_id:
  8339. logger.info("[LAYER-TL] Attaching timelapse %s to archive %s", timelapse_path, archive_id)
  8340. async with async_session() as db:
  8341. service = ArchiveService(db)
  8342. timelapse_data = await asyncio.to_thread(timelapse_path.read_bytes)
  8343. await service.attach_timelapse(
  8344. archive_id, timelapse_data, "layer_timelapse.mp4", plate_id=notify_plate_id
  8345. )
  8346. # Clean up the temp file
  8347. await asyncio.to_thread(timelapse_path.unlink, missing_ok=True)
  8348. logger.info("[LAYER-TL] Layer timelapse attached successfully")
  8349. elif timelapse_path:
  8350. # Timelapse created but no archive - just clean up
  8351. await asyncio.to_thread(timelapse_path.unlink, missing_ok=True)
  8352. else:
  8353. # Print failed or cancelled - cancel timelapse session
  8354. cancel_session(printer_id)
  8355. logger.info(
  8356. "[LAYER-TL] Cancelled layer timelapse for printer %s (status: %s)", printer_id, print_status
  8357. )
  8358. except Exception as e:
  8359. logger.warning("[LAYER-TL] Failed: %s", e)
  8360. # A completed print's session left _active_sessions when its stitch
  8361. # began: the one there now belongs to the next print, which may have
  8362. # started during the stitch, and must not lose its frames.
  8363. if print_status != "completed":
  8364. try:
  8365. cancel_session(printer_id)
  8366. except Exception:
  8367. pass # Best-effort timelapse session cancellation on error
  8368. spawn_background_task(_background_layer_timelapse(), name="background-layer-timelapse")
  8369. log_timing("All background tasks scheduled")
  8370. # Auto-scan for timelapse if recording was active during the print
  8371. if archive_id and data.get("timelapse_was_active") and data.get("status") == "completed":
  8372. logger.info("[TIMELAPSE] Timelapse was active during print, scheduling auto-scan for archive %s", archive_id)
  8373. # Schedule timelapse scan as background task with retries
  8374. # The printer needs time to encode the video after print completion
  8375. baseline = _timelapse_baselines.pop(printer_id, None)
  8376. spawn_background_task(
  8377. _scan_for_timelapse_with_retries(archive_id, baseline, plate_id=notify_plate_id),
  8378. name=f"scan-timelapse-{archive_id}",
  8379. )
  8380. log_timing("Timelapse scan scheduled")
  8381. logger.info("[CALLBACK] on_print_complete finished for printer %s, archive %s", printer_id, archive_id)
  8382. # AMS sensor history recording
  8383. _ams_history_task: asyncio.Task | None = None
  8384. AMS_HISTORY_INTERVAL = 300 # Record every 5 minutes
  8385. AMS_HISTORY_RETENTION_DAYS = 30 # Keep data for 30 days
  8386. def _retention_days(stored: str | None, default: int) -> int:
  8387. """A history retention setting as days to keep: at least 1, the default
  8388. when unset or unreadable. A stored 0 or less (the API took one before it
  8389. had a minimum) would put the cutoff at now and delete all history."""
  8390. try:
  8391. return max(1, int(stored)) if stored is not None else default
  8392. except (TypeError, ValueError):
  8393. return default
  8394. _ams_cleanup_counter = 0 # Track recordings to trigger periodic cleanup
  8395. # Track alarm cooldowns (printer_id:ams_id:type -> last_alarm_time)
  8396. _ams_alarm_cooldown: dict[str, datetime] = {}
  8397. AMS_ALARM_COOLDOWN_MINUTES = 60 # Don't send same alarm more than once per hour
  8398. # (printer_id, ams_id) already reported as sending the drop index and no
  8399. # percentage. Logged once each so a supported printer that turns out to do this
  8400. # shows up in a support bundle rather than as a user wondering where the
  8401. # humidity reading went -- see the note at the read site below (#3140).
  8402. _ams_index_only_logged: set[tuple[int, int]] = set()
  8403. def _resolve_temp_alarm_threshold(fair_threshold: float, raw_alarm_value: str | None) -> float:
  8404. """Temperature at which the AMS alarm fires, falling back to the display band.
  8405. ``ams_temp_fair`` decides when the AMS card turns amber. It used to decide
  8406. when a notification was sent as well, which is why a room above it made the
  8407. alarm fire once an hour for as long as the weather lasted -- and the only way
  8408. to stop that was to raise the display band and lose the colour that says the
  8409. unit is warm (#2905).
  8410. Unset resolves to the fair threshold, so an install that never sets one is
  8411. unchanged. Settings storage stringifies ``None`` to the literal ``"None"``,
  8412. so that arrives here as a string and is handled by the same branch as any
  8413. other unparseable value -- there is no separate sentinel to keep in sync.
  8414. A non-positive value is refused rather than honoured: zero would alarm
  8415. permanently, and it is far more likely to be a cleared field than a
  8416. deliberate choice.
  8417. """
  8418. if raw_alarm_value is None:
  8419. return fair_threshold
  8420. try:
  8421. value = float(raw_alarm_value)
  8422. except (TypeError, ValueError):
  8423. return fair_threshold
  8424. if not math.isfinite(value) or value <= 0:
  8425. return fair_threshold
  8426. return value
  8427. # Per-AMS "drying was live at" latch that suppresses the high-temperature alarm
  8428. # through a cycle and the cool-down after it (#1802). Stored in the settings
  8429. # table rather than alongside _ams_alarm_cooldown above, because a restart
  8430. # partway through a cool-down would otherwise resume alarming about heat the
  8431. # user asked for — the same internal-timestamp-row pattern as
  8432. # support.py's debug_logging_enabled_at.
  8433. AMS_DRYING_LATCH_KEY = "ams_drying_alarm_latch"
  8434. # Upper bound on that suppression. The latch normally clears as soon as the unit
  8435. # reads at or below the threshold; see utils.ams_drying for why this cap only
  8436. # matters when it never does.
  8437. AMS_DRYING_GRACE_MINUTES = 120
  8438. async def _load_ams_drying_latch(db) -> dict[str, datetime]:
  8439. """Read the persisted per-AMS drying latch, dropping entries out of window.
  8440. Anything older than the grace cap would expire on its next visit anyway, so
  8441. discarding it here costs nothing and stops rows for deleted printers from
  8442. accumulating.
  8443. Stamps ahead of now get two defences, because a box whose clock jumps
  8444. backwards (a Pi with no RTC coming up before NTP) writes them: wildly future
  8445. ones are discarded outright, and the rest are clamped to now. Without the
  8446. clamp the cap would measure from a moment that has not happened yet and hold
  8447. the alarm quiet for the skew on top of the cap. One unnecessary notification
  8448. after a clock jump is a far better failure than an alarm silently disabled
  8449. for hours.
  8450. """
  8451. from backend.app.models.settings import Settings
  8452. result = await db.execute(select(Settings).where(Settings.key == AMS_DRYING_LATCH_KEY))
  8453. setting = result.scalar_one_or_none()
  8454. if not setting or not setting.value:
  8455. return {}
  8456. try:
  8457. raw = json.loads(setting.value)
  8458. except (ValueError, TypeError):
  8459. return {} # Corrupted row → no latch, alarms behave as they did before
  8460. if not isinstance(raw, dict):
  8461. return {}
  8462. now = datetime.now(timezone.utc)
  8463. window = timedelta(minutes=AMS_DRYING_GRACE_MINUTES)
  8464. latch: dict[str, datetime] = {}
  8465. for key, value in raw.items():
  8466. try:
  8467. stamp = datetime.fromisoformat(str(value))
  8468. except (ValueError, TypeError):
  8469. continue
  8470. if stamp.tzinfo is None:
  8471. stamp = stamp.replace(tzinfo=timezone.utc)
  8472. if not (now - window <= stamp <= now + window):
  8473. continue
  8474. # Nothing may sit in the future: suppression is measured as now minus
  8475. # the stamp, so a stamp ahead of now would extend it by the skew on top
  8476. # of the cap. Clamping the survivors keeps the cap an actual cap.
  8477. latch[str(key)] = min(stamp, now)
  8478. return latch
  8479. async def _save_ams_drying_latch(db, latch: dict[str, datetime]) -> None:
  8480. """Persist the latch, writing only when it actually changed.
  8481. Adds the session change but does not commit — the caller's own commit
  8482. carries it, so the latch lands in the same transaction as the sensor rows
  8483. that produced it.
  8484. """
  8485. from backend.app.models.settings import Settings
  8486. payload = json.dumps({key: stamp.isoformat() for key, stamp in sorted(latch.items())})
  8487. result = await db.execute(select(Settings).where(Settings.key == AMS_DRYING_LATCH_KEY))
  8488. setting = result.scalar_one_or_none()
  8489. if setting is None:
  8490. # Don't create the row on installs that never dry anything.
  8491. if payload != "{}":
  8492. db.add(Settings(key=AMS_DRYING_LATCH_KEY, value=payload))
  8493. elif setting.value != payload:
  8494. setting.value = payload
  8495. def _ams_has_filament(ams_data: dict) -> bool:
  8496. """True if this AMS unit has at least one tray slot holding filament.
  8497. Bambu firmware reports loaded slots via `tray_exist_bits`, a per-AMS hex
  8498. bitmap (one bit per tray slot — bit set = spool present). Empty AMS units
  8499. still report sensor readings, but those readings are ambient and not
  8500. actionable: no filament to dry, no humidity to push down. #1619 — gate
  8501. humidity/temperature alarms on this check so empty units don't generate
  8502. hourly noise. Sensor history still records regardless so the UI charts
  8503. stay continuous.
  8504. Fallback path inspects the `tray` array's `tray_type` fields for setups
  8505. where `tray_exist_bits` is missing (some early-connection pushall shapes).
  8506. """
  8507. bits = ams_data.get("tray_exist_bits")
  8508. if isinstance(bits, str) and bits.strip():
  8509. try:
  8510. return int(bits, 16) > 0
  8511. except ValueError:
  8512. pass
  8513. trays = ams_data.get("tray")
  8514. if isinstance(trays, list):
  8515. return any(
  8516. isinstance(t, dict) and isinstance(t.get("tray_type"), str) and t["tray_type"].strip() for t in trays
  8517. )
  8518. return False
  8519. async def record_ams_history():
  8520. """Background task to record AMS humidity and temperature data."""
  8521. logger = logging.getLogger(__name__)
  8522. # Wait a short time for MQTT connections to establish on startup
  8523. await asyncio.sleep(10)
  8524. while True:
  8525. try:
  8526. from backend.app.models.ams_history import AMSSensorHistory
  8527. from backend.app.models.printer import Printer
  8528. from backend.app.models.settings import Settings
  8529. async with async_session() as db:
  8530. # Get all active printers
  8531. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  8532. printers = result.scalars().all()
  8533. # Get alarm thresholds from settings
  8534. humidity_threshold = 60.0 # Default: fair threshold
  8535. temp_fair_threshold = 35.0 # Display band default (ams_temp_fair)
  8536. result = await db.execute(select(Settings).where(Settings.key == "ams_humidity_fair"))
  8537. setting = result.scalar_one_or_none()
  8538. if setting:
  8539. try:
  8540. humidity_threshold = float(setting.value)
  8541. except (ValueError, TypeError):
  8542. pass # Keep default threshold if stored value is invalid
  8543. result = await db.execute(select(Settings).where(Settings.key == "ams_temp_fair"))
  8544. setting = result.scalar_one_or_none()
  8545. if setting:
  8546. try:
  8547. temp_fair_threshold = float(setting.value)
  8548. except (ValueError, TypeError):
  8549. pass # Keep default threshold if stored value is invalid
  8550. # The alarm gets its own threshold, seeded from the resolved fair
  8551. # value so an install that has never set one behaves exactly as
  8552. # it did before (#2905). ams_temp_fair decides when the card turns
  8553. # amber; 35 C is a reasonable place to change a colour and not a
  8554. # reasonable place to page someone. A room above it makes the
  8555. # alarm fire once an hour for as long as the weather lasts, and
  8556. # the only way to stop it was to raise the display band and lose
  8557. # the colour that says the unit is warm.
  8558. #
  8559. # An unset value is stored as the literal "None", which the except
  8560. # below swallows the same way it swallows garbage -- so the
  8561. # fallback costs nothing and needs no sentinel of its own.
  8562. result = await db.execute(select(Settings).where(Settings.key == "ams_temp_alarm"))
  8563. setting = result.scalar_one_or_none()
  8564. temp_alarm_threshold = _resolve_temp_alarm_threshold(
  8565. temp_fair_threshold, setting.value if setting else None
  8566. )
  8567. # Per-filament humidity threshold overrides (#1605) — resolved
  8568. # per-AMS below from the loaded tray types. Reuses the same
  8569. # resolver as the auto-drying scheduler so behavior stays in
  8570. # lockstep across both consumers.
  8571. from backend.app.services.print_scheduler import PrintScheduler
  8572. per_type_humidity_thresholds: dict[str, int] = {}
  8573. result = await db.execute(select(Settings).where(Settings.key == "ams_humidity_thresholds"))
  8574. setting = result.scalar_one_or_none()
  8575. if setting and setting.value:
  8576. try:
  8577. raw = json.loads(setting.value)
  8578. if isinstance(raw, dict):
  8579. for k, v in raw.items():
  8580. try:
  8581. per_type_humidity_thresholds[str(k).upper() if k != "default" else "default"] = int(
  8582. v
  8583. )
  8584. except (TypeError, ValueError):
  8585. continue
  8586. except (ValueError, TypeError):
  8587. pass # Invalid JSON → no overrides, fall through to global threshold
  8588. # Per-AMS drying latch (#1802), loaded once per pass and written
  8589. # back below only if a unit changed it.
  8590. drying_latch = await _load_ams_drying_latch(db)
  8591. drying_latch_before = dict(drying_latch)
  8592. recorded_count = 0
  8593. for printer in printers:
  8594. # Get current state from printer manager
  8595. state = printer_manager.get_status(printer.id)
  8596. if not state or not state.connected or not state.raw_data:
  8597. continue # Skip disconnected printers - don't use stale data
  8598. raw_data = state.raw_data
  8599. if "ams" not in raw_data or not isinstance(raw_data["ams"], list):
  8600. continue
  8601. # Record data for each AMS unit
  8602. for ams_data in raw_data["ams"]:
  8603. ams_id = int(ams_data.get("id", 0))
  8604. # Percentage only. The 1-5 index is inverted, so
  8605. # charting it as a percentage drew the wettest units as
  8606. # the driest (#3140); a unit that reports no percentage
  8607. # leaves a gap in the chart instead. See
  8608. # utils/ams_humidity.
  8609. humidity = ams_humidity_percent(ams_data)
  8610. # No supported printer is known to send the index
  8611. # alone -- the report came from unsupported firmware,
  8612. # and no install has been seen using the old fallback.
  8613. # "Known" is doing work there, so say so once per unit:
  8614. # the alternative is a silent blank card.
  8615. if humidity is None and ams_data.get("humidity") is not None:
  8616. unit_key = (printer.id, ams_id)
  8617. if unit_key not in _ams_index_only_logged:
  8618. _ams_index_only_logged.add(unit_key)
  8619. logger.info(
  8620. "[%s] AMS %d reports the 1-5 humidity index but no usable humidity_raw "
  8621. "percentage. The index is inverted and is not shown as a percentage "
  8622. "(#3140), so this unit has no humidity reading, chart or alarm. "
  8623. "Please report this with the printer and AMS firmware versions.",
  8624. printer.name,
  8625. ams_id,
  8626. )
  8627. # Get temperature
  8628. temperature = None
  8629. temp_str = ams_data.get("temp")
  8630. if temp_str is not None:
  8631. try:
  8632. temperature = float(temp_str)
  8633. except (ValueError, TypeError):
  8634. pass # Skip unparseable temperature value
  8635. # Skip if no data
  8636. if humidity is None and temperature is None:
  8637. continue
  8638. # Record the data point
  8639. history = AMSSensorHistory(
  8640. printer_id=printer.id,
  8641. ams_id=ams_id,
  8642. humidity=humidity,
  8643. # Both columns hold the same reading now that the
  8644. # index can no longer reach ``humidity``. Writing it
  8645. # through the same value also stops a genuine 0%
  8646. # from being stored as NULL, which the old truthiness
  8647. # test did.
  8648. humidity_raw=humidity,
  8649. temperature=temperature,
  8650. )
  8651. db.add(history)
  8652. recorded_count += 1
  8653. # Generate AMS label and determine if it's AMS-HT (A, B, C, D or HT-A for AMS-Lite/Hub)
  8654. is_ams_ht = ams_id >= 128
  8655. if is_ams_ht:
  8656. ams_label = f"HT-{chr(65 + (ams_id - 128))}"
  8657. else:
  8658. ams_label = f"AMS-{chr(65 + ams_id)}"
  8659. # Skip alarm dispatch for empty AMS units — humidity /
  8660. # temperature readings are ambient with no filament to
  8661. # protect, and the hourly notification just becomes
  8662. # noise. Sensor history was already recorded above so
  8663. # the UI charts stay continuous (#1619). Per-AMS check
  8664. # so a multi-AMS setup with one loaded + one empty
  8665. # still alarms on the loaded unit.
  8666. if not _ams_has_filament(ams_data):
  8667. continue
  8668. # Resolve per-filament humidity threshold for this AMS
  8669. # unit (#1605). Falls back to the global ams_humidity_fair
  8670. # when no per-type overrides are configured.
  8671. trays = ams_data.get("tray", []) or []
  8672. effective_humidity_threshold = float(
  8673. PrintScheduler.resolve_humidity_threshold(
  8674. trays, per_type_humidity_thresholds, int(humidity_threshold)
  8675. )
  8676. )
  8677. # Check humidity alarm (only if above threshold)
  8678. if humidity is not None and humidity > effective_humidity_threshold:
  8679. cooldown_key = f"{printer.id}:{ams_id}:humidity"
  8680. last_alarm = _ams_alarm_cooldown.get(cooldown_key)
  8681. now = datetime.now(timezone.utc)
  8682. if (
  8683. last_alarm is None
  8684. or (now - last_alarm).total_seconds() >= AMS_ALARM_COOLDOWN_MINUTES * 60
  8685. ):
  8686. _ams_alarm_cooldown[cooldown_key] = now
  8687. logger.info(
  8688. f"Sending humidity alarm for {printer.name} {ams_label}: {humidity}% > {effective_humidity_threshold}%"
  8689. )
  8690. try:
  8691. # Call different notification method based on AMS type
  8692. if is_ams_ht:
  8693. await notification_service.on_ams_ht_humidity_high(
  8694. printer.id,
  8695. printer.name,
  8696. ams_label,
  8697. humidity,
  8698. effective_humidity_threshold,
  8699. db,
  8700. )
  8701. else:
  8702. await notification_service.on_ams_humidity_high(
  8703. printer.id,
  8704. printer.name,
  8705. ams_label,
  8706. humidity,
  8707. effective_humidity_threshold,
  8708. db,
  8709. )
  8710. except Exception as e:
  8711. logger.warning("Failed to send humidity alarm: %s", e)
  8712. # A drying cycle heats the unit far past ams_temp_fair on
  8713. # purpose — 45 C for PLA, 65 C for PETG, 85 C on an
  8714. # AMS-HT, against a 35 C default — so the alarm fired
  8715. # once an hour for the whole cycle and kept firing while
  8716. # the unit cooled back down (#1802). Latch on the
  8717. # firmware's own drying state and hold until the reading
  8718. # returns to normal. Humidity is deliberately left alone:
  8719. # it falls during drying, which is the whole point.
  8720. latch_key = f"{printer.id}:{ams_id}"
  8721. # The latch releases at `threshold`, so it takes the alarm
  8722. # number too. Handing it the display band would strand the
  8723. # latch on any unit that settles back above it -- a room
  8724. # where the AMS rests at 37.7 C never returns under a 35 C
  8725. # band, so the latch could only expire on the grace cap
  8726. # rather than releasing when the unit had actually cooled.
  8727. suppress_temp_alarm, new_latch = temperature_alarm_suppressed(
  8728. drying_active=is_drying_active(ams_data),
  8729. temperature=temperature,
  8730. threshold=temp_alarm_threshold,
  8731. latched_at=drying_latch.get(latch_key),
  8732. now=datetime.now(timezone.utc),
  8733. grace_minutes=AMS_DRYING_GRACE_MINUTES,
  8734. )
  8735. if new_latch is None:
  8736. drying_latch.pop(latch_key, None)
  8737. else:
  8738. drying_latch[latch_key] = new_latch
  8739. # Check temperature alarm (only if above threshold)
  8740. if temperature is not None and temperature > temp_alarm_threshold and not suppress_temp_alarm:
  8741. cooldown_key = f"{printer.id}:{ams_id}:temperature"
  8742. last_alarm = _ams_alarm_cooldown.get(cooldown_key)
  8743. now = datetime.now(timezone.utc)
  8744. if (
  8745. last_alarm is None
  8746. or (now - last_alarm).total_seconds() >= AMS_ALARM_COOLDOWN_MINUTES * 60
  8747. ):
  8748. _ams_alarm_cooldown[cooldown_key] = now
  8749. logger.info(
  8750. f"Sending temperature alarm for {printer.name} {ams_label}: "
  8751. f"{temperature}°C > {temp_alarm_threshold}°C"
  8752. )
  8753. try:
  8754. # Call different notification method based on AMS type
  8755. if is_ams_ht:
  8756. # The reported threshold has to be the one
  8757. # that fired, or the message says "> 35 °C"
  8758. # while firing at 45.
  8759. await notification_service.on_ams_ht_temperature_high(
  8760. printer.id, printer.name, ams_label, temperature, temp_alarm_threshold, db
  8761. )
  8762. else:
  8763. await notification_service.on_ams_temperature_high(
  8764. printer.id, printer.name, ams_label, temperature, temp_alarm_threshold, db
  8765. )
  8766. except Exception as e:
  8767. logger.warning("Failed to send temperature alarm: %s", e)
  8768. if drying_latch != drying_latch_before:
  8769. await _save_ams_drying_latch(db, drying_latch)
  8770. await db.commit()
  8771. if recorded_count > 0:
  8772. logger.info("Recorded %s AMS sensor history entries", recorded_count)
  8773. # Periodic cleanup of old data (every ~288 recordings = ~24 hours at 5min interval)
  8774. global _ams_cleanup_counter
  8775. _ams_cleanup_counter += 1
  8776. if _ams_cleanup_counter >= 288:
  8777. _ams_cleanup_counter = 0
  8778. # Get retention days from settings
  8779. from backend.app.models.settings import Settings
  8780. result = await db.execute(select(Settings).where(Settings.key == "ams_history_retention_days"))
  8781. setting = result.scalar_one_or_none()
  8782. retention_days = _retention_days(setting.value if setting else None, AMS_HISTORY_RETENTION_DAYS)
  8783. cutoff = utcnow_naive() - timedelta(days=retention_days)
  8784. result = await db.execute(delete(AMSSensorHistory).where(AMSSensorHistory.recorded_at < cutoff))
  8785. await db.commit()
  8786. if result.rowcount > 0:
  8787. logger.info(
  8788. f"Cleaned up {result.rowcount} old AMS sensor history entries (older than {retention_days} days)"
  8789. )
  8790. # Wait until next recording interval
  8791. await asyncio.sleep(AMS_HISTORY_INTERVAL)
  8792. except asyncio.CancelledError:
  8793. break
  8794. except Exception as e:
  8795. logger.warning("AMS history recording failed: %s", e)
  8796. await asyncio.sleep(60) # Wait a bit before retrying
  8797. def start_ams_history_recording():
  8798. """Start the AMS history recording background task."""
  8799. global _ams_history_task
  8800. if _ams_history_task is None:
  8801. _ams_history_task = asyncio.create_task(record_ams_history())
  8802. logging.getLogger(__name__).info("AMS history recording started")
  8803. def stop_ams_history_recording():
  8804. """Stop the AMS history recording background task."""
  8805. global _ams_history_task
  8806. if _ams_history_task:
  8807. _ams_history_task.cancel()
  8808. _ams_history_task = None
  8809. logging.getLogger(__name__).info("AMS history recording stopped")
  8810. # Printer sensor history recording (nozzle / bed / chamber)
  8811. _printer_sensor_history_task: asyncio.Task | None = None
  8812. PRINTER_SENSOR_HISTORY_INTERVAL = 60 # Record every minute — heaters move faster than AMS humidity
  8813. PRINTER_SENSOR_HISTORY_RETENTION_DAYS = 30
  8814. _printer_sensor_cleanup_counter = 0
  8815. # Sensor kinds tracked in state.temperatures — these are the normalised keys the
  8816. # MQTT parser writes, so we don't need to handle per-model field aliases here
  8817. # (nozzle_temper / left_nozzle_temper / right_nozzle_temper / chamber_temper
  8818. # are all collapsed by services/bambu_mqtt.py before they reach this loop).
  8819. _SENSOR_KINDS = ("nozzle", "nozzle_2", "bed", "chamber")
  8820. _SENSOR_TARGET_KEYS = {
  8821. "nozzle": "nozzle_target",
  8822. "nozzle_2": "nozzle_2_target",
  8823. "bed": "bed_target",
  8824. "chamber": "chamber_target",
  8825. }
  8826. async def record_printer_sensor_history():
  8827. """Background task to record nozzle / bed / chamber readings.
  8828. Pulls from `state.temperatures` (already normalised across all printer
  8829. models by the MQTT parser) rather than re-parsing raw_data, so we get
  8830. free coverage of dual-nozzle H2D, sensor-only X1C chamber, etc.
  8831. """
  8832. logger = logging.getLogger(__name__)
  8833. await asyncio.sleep(10)
  8834. while True:
  8835. try:
  8836. from backend.app.models.printer import Printer
  8837. from backend.app.models.printer_sensor_history import PrinterSensorHistory
  8838. from backend.app.models.settings import Settings
  8839. async with async_session() as db:
  8840. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  8841. printers = result.scalars().all()
  8842. recorded_count = 0
  8843. for printer in printers:
  8844. state = printer_manager.get_status(printer.id)
  8845. if not state or not state.connected:
  8846. continue
  8847. temps = getattr(state, "temperatures", None) or {}
  8848. if not isinstance(temps, dict):
  8849. continue
  8850. for kind in _SENSOR_KINDS:
  8851. if kind not in temps:
  8852. continue
  8853. try:
  8854. value = float(temps[kind])
  8855. except (ValueError, TypeError):
  8856. continue
  8857. target_raw = temps.get(_SENSOR_TARGET_KEYS[kind])
  8858. target_val: float | None = None
  8859. if target_raw is not None:
  8860. try:
  8861. target_val = float(target_raw)
  8862. except (ValueError, TypeError):
  8863. target_val = None
  8864. db.add(
  8865. PrinterSensorHistory(
  8866. printer_id=printer.id,
  8867. sensor_kind=kind,
  8868. value=value,
  8869. target=target_val,
  8870. )
  8871. )
  8872. recorded_count += 1
  8873. await db.commit()
  8874. if recorded_count > 0:
  8875. logger.debug("Recorded %s printer sensor history entries", recorded_count)
  8876. # Periodic cleanup — once every ~24h at this interval.
  8877. global _printer_sensor_cleanup_counter
  8878. _printer_sensor_cleanup_counter += 1
  8879. cleanup_every = max(1, (24 * 60 * 60) // PRINTER_SENSOR_HISTORY_INTERVAL)
  8880. if _printer_sensor_cleanup_counter >= cleanup_every:
  8881. _printer_sensor_cleanup_counter = 0
  8882. result = await db.execute(
  8883. select(Settings).where(Settings.key == "printer_sensor_history_retention_days")
  8884. )
  8885. setting = result.scalar_one_or_none()
  8886. retention_days = _retention_days(
  8887. setting.value if setting else None, PRINTER_SENSOR_HISTORY_RETENTION_DAYS
  8888. )
  8889. cutoff = utcnow_naive() - timedelta(days=retention_days)
  8890. cleanup = await db.execute(
  8891. delete(PrinterSensorHistory).where(PrinterSensorHistory.recorded_at < cutoff)
  8892. )
  8893. await db.commit()
  8894. if cleanup.rowcount > 0:
  8895. logger.info(
  8896. "Cleaned up %s old printer sensor history entries (older than %s days)",
  8897. cleanup.rowcount,
  8898. retention_days,
  8899. )
  8900. await asyncio.sleep(PRINTER_SENSOR_HISTORY_INTERVAL)
  8901. except asyncio.CancelledError:
  8902. break
  8903. except Exception as e:
  8904. logger.warning("Printer sensor history recording failed: %s", e)
  8905. await asyncio.sleep(60)
  8906. def start_printer_sensor_history_recording():
  8907. global _printer_sensor_history_task
  8908. if _printer_sensor_history_task is None:
  8909. _printer_sensor_history_task = asyncio.create_task(record_printer_sensor_history())
  8910. logging.getLogger(__name__).info("Printer sensor history recording started")
  8911. def stop_printer_sensor_history_recording():
  8912. global _printer_sensor_history_task
  8913. if _printer_sensor_history_task:
  8914. _printer_sensor_history_task.cancel()
  8915. _printer_sensor_history_task = None
  8916. logging.getLogger(__name__).info("Printer sensor history recording stopped")
  8917. # Printer runtime tracking
  8918. _runtime_tracking_task: asyncio.Task | None = None
  8919. RUNTIME_TRACKING_INTERVAL = 30 # Update every 30 seconds
  8920. async def track_printer_runtime():
  8921. """Background task to track printer active runtime (RUNNING state only).
  8922. PAUSE is intentionally excluded — the runtime counter feeds hours-based
  8923. maintenance intervals (rod lubrication, belt checks, nozzle cleaning)
  8924. which track mechanical wear. Pause time has no motion and no wear, so
  8925. counting it inflates maintenance warnings (#1521).
  8926. """
  8927. logger = logging.getLogger(__name__)
  8928. # Wait for MQTT connections to establish on startup
  8929. await asyncio.sleep(15)
  8930. while True:
  8931. try:
  8932. from backend.app.models.printer import Printer
  8933. # Fetch printer IDs in a short-lived read-only session
  8934. async with async_session() as db:
  8935. result = await db.execute(
  8936. select(Printer.id, Printer.name, Printer.runtime_seconds, Printer.last_runtime_update).where(
  8937. Printer.is_active.is_(True)
  8938. )
  8939. )
  8940. printer_rows = result.all()
  8941. now = datetime.now(timezone.utc)
  8942. updated_count = 0
  8943. # Update each printer in its own short session to minimise write-lock
  8944. # hold time and avoid blocking critical commits like queue status
  8945. # updates (#897).
  8946. for pid, pname, runtime_secs, last_update in printer_rows:
  8947. state = printer_manager.get_status(pid)
  8948. if not state:
  8949. logger.debug("[%s] Runtime tracking: no state available", pname)
  8950. continue
  8951. if not state.connected:
  8952. logger.debug("[%s] Runtime tracking: not connected", pname)
  8953. continue
  8954. needs_commit = False
  8955. new_runtime = runtime_secs
  8956. new_last_update = last_update
  8957. if state.state == "RUNNING":
  8958. if last_update:
  8959. lu = last_update if last_update.tzinfo else last_update.replace(tzinfo=timezone.utc)
  8960. elapsed = (now - lu).total_seconds()
  8961. if elapsed > 0:
  8962. new_runtime = runtime_secs + int(elapsed)
  8963. updated_count += 1
  8964. needs_commit = True
  8965. logger.debug(
  8966. f"[{pname}] Runtime tracking: added {int(elapsed)}s, "
  8967. f"total={new_runtime}s ({new_runtime / 3600:.2f}h)"
  8968. )
  8969. else:
  8970. needs_commit = True
  8971. logger.debug("[%s] Runtime tracking: first active detection", pname)
  8972. new_last_update = now
  8973. else:
  8974. if last_update is not None:
  8975. logger.debug(f"[{pname}] Runtime tracking: state={state.state}, clearing last_runtime_update")
  8976. new_last_update = None
  8977. needs_commit = True
  8978. if needs_commit:
  8979. try:
  8980. async with async_session() as db:
  8981. result = await db.execute(select(Printer).where(Printer.id == pid))
  8982. printer = result.scalar_one_or_none()
  8983. if printer:
  8984. printer.runtime_seconds = new_runtime
  8985. printer.last_runtime_update = new_last_update
  8986. await db.commit()
  8987. except Exception as e:
  8988. logger.warning("[%s] Runtime tracking commit failed: %s", pname, e)
  8989. if updated_count > 0:
  8990. logger.debug("Updated runtime for %s printer(s)", updated_count)
  8991. except asyncio.CancelledError:
  8992. logger.info("Runtime tracking cancelled")
  8993. break
  8994. except Exception as e:
  8995. logger.warning("Runtime tracking failed: %s", e)
  8996. await asyncio.sleep(RUNTIME_TRACKING_INTERVAL)
  8997. def start_runtime_tracking():
  8998. """Start the printer runtime tracking background task."""
  8999. global _runtime_tracking_task
  9000. if _runtime_tracking_task is None:
  9001. _runtime_tracking_task = asyncio.create_task(track_printer_runtime())
  9002. logging.getLogger(__name__).info("Printer runtime tracking started")
  9003. def stop_runtime_tracking():
  9004. """Stop the printer runtime tracking background task."""
  9005. global _runtime_tracking_task
  9006. if _runtime_tracking_task:
  9007. _runtime_tracking_task.cancel()
  9008. _runtime_tracking_task = None
  9009. logging.getLogger(__name__).info("Printer runtime tracking stopped")
  9010. # SpoolBuddy device watchdog
  9011. _spoolbuddy_watchdog_task: asyncio.Task | None = None
  9012. SPOOLBUDDY_WATCHDOG_INTERVAL = 15
  9013. async def _spoolbuddy_watchdog_loop():
  9014. """Periodic check for SpoolBuddy devices that have gone offline."""
  9015. from backend.app.api.routes.spoolbuddy import spoolbuddy_watchdog
  9016. while True:
  9017. try:
  9018. await spoolbuddy_watchdog()
  9019. except asyncio.CancelledError:
  9020. break
  9021. except Exception as e:
  9022. logging.getLogger(__name__).warning("SpoolBuddy watchdog failed: %s", e)
  9023. await asyncio.sleep(SPOOLBUDDY_WATCHDOG_INTERVAL)
  9024. def start_spoolbuddy_watchdog():
  9025. global _spoolbuddy_watchdog_task
  9026. if _spoolbuddy_watchdog_task is None:
  9027. _spoolbuddy_watchdog_task = asyncio.create_task(_spoolbuddy_watchdog_loop())
  9028. logging.getLogger(__name__).info("SpoolBuddy watchdog started")
  9029. def stop_spoolbuddy_watchdog():
  9030. global _spoolbuddy_watchdog_task
  9031. if _spoolbuddy_watchdog_task:
  9032. _spoolbuddy_watchdog_task.cancel()
  9033. _spoolbuddy_watchdog_task = None
  9034. logging.getLogger(__name__).info("SpoolBuddy watchdog stopped")
  9035. # Dead-MQTT-session recovery
  9036. #
  9037. # check_staleness() covers the "connected but silent" half-broken session. It
  9038. # does nothing once ``state.connected`` is False, and paho's own auto-reconnect
  9039. # is the only thing left watching at that point. When paho stops making
  9040. # progress there is no backstop at all: the #2732 bundle has a P1S drop on a
  9041. # keep-alive timeout at 02:19 and not reconnect until 11:24 — nine hours
  9042. # offline with the UI open the whole time, recovered only when something
  9043. # happened to nudge it.
  9044. #
  9045. # This loop is that backstop. It only touches printers that had a working
  9046. # session and lost it, and only when the MQTT port still answers — a printer
  9047. # that is simply switched off is left to paho, since rebuilding a client
  9048. # against an unreachable host achieves nothing and would fill the log every
  9049. # night.
  9050. _connection_watchdog_task: asyncio.Task | None = None
  9051. CONNECTION_WATCHDOG_INTERVAL = 60
  9052. # How long a printer must have been silent before we stop trusting paho.
  9053. # Comfortably above STALE_TIMEOUT (60 s) and the max reconnect backoff (30 s),
  9054. # so a session that is recovering on its own is never interrupted.
  9055. CONNECTION_WATCHDOG_OFFLINE_GRACE = 300
  9056. # Per-printer floor between rebuild attempts.
  9057. CONNECTION_WATCHDOG_RETRY_INTERVAL = 300
  9058. _connection_watchdog_last_attempt: dict[int, float] = {}
  9059. async def _recover_dead_printer_sessions() -> int:
  9060. """Rebuild MQTT clients that have been offline too long to still be trying.
  9061. Returns the number of printers a rebuild was attempted for (for tests and
  9062. for the caller's logging). Never raises: one unreachable printer must not
  9063. stop the sweep for the rest of the farm.
  9064. """
  9065. logger = logging.getLogger(__name__)
  9066. from backend.app.services.printer_diagnostic import PORT_MQTT, check_port
  9067. now = time.monotonic()
  9068. recovered = 0
  9069. for printer_id, client in list(printer_manager._clients.items()):
  9070. try:
  9071. if client.state.connected:
  9072. _connection_watchdog_last_attempt.pop(printer_id, None)
  9073. continue
  9074. # Time since the last inbound message is the age of the last known
  9075. # good session — no extra bookkeeping needed, and it is the same
  9076. # clock is_stale() reads. 0 means this client has never had one:
  9077. # that is the initial-connect path, where paho retrying is the
  9078. # correct and only behaviour, so leave it be.
  9079. last_msg = client._last_message_time
  9080. if not last_msg:
  9081. continue
  9082. offline_for = time.time() - last_msg
  9083. if offline_for < CONNECTION_WATCHDOG_OFFLINE_GRACE:
  9084. continue
  9085. last_attempt = _connection_watchdog_last_attempt.get(printer_id)
  9086. if last_attempt is not None and now - last_attempt < CONNECTION_WATCHDOG_RETRY_INTERVAL:
  9087. continue
  9088. if not await check_port(client.ip_address, PORT_MQTT):
  9089. # Switched off, unplugged, or off the network. Paho's retry is
  9090. # the right handler; say so at debug level and move on.
  9091. logger.debug(
  9092. "[#2732] Printer %s offline for %.0fs and its MQTT port is not answering "
  9093. "— leaving the reconnect to paho",
  9094. printer_id,
  9095. offline_for,
  9096. )
  9097. _connection_watchdog_last_attempt[printer_id] = now
  9098. continue
  9099. _connection_watchdog_last_attempt[printer_id] = now
  9100. recovered += 1
  9101. logger.warning(
  9102. "[#2732] Printer %s has been offline for %.0fs but answers on MQTT port %d — "
  9103. "rebuilding the client with a fresh session (last connect error: %s)",
  9104. printer_id,
  9105. offline_for,
  9106. PORT_MQTT,
  9107. client.last_connect_error or "none recorded",
  9108. )
  9109. # Async context, so this takes the hard-reset path: fresh client_id,
  9110. # paho's QoS 1 queue dropped. That matters — a project_file left
  9111. # unacked on the dead session would otherwise replay into the new
  9112. # one and trip 0500_4003 on the printer (#1136).
  9113. client.force_reconnect_stale_session(f"offline for {offline_for:.0f}s, port still answering")
  9114. except Exception as e:
  9115. logger.warning("[#2732] Connection watchdog failed for printer %s: %s", printer_id, e)
  9116. return recovered
  9117. async def _connection_watchdog_loop():
  9118. logger = logging.getLogger(__name__)
  9119. # Let the initial connects settle before judging anyone offline.
  9120. await asyncio.sleep(CONNECTION_WATCHDOG_OFFLINE_GRACE)
  9121. while True:
  9122. try:
  9123. await _recover_dead_printer_sessions()
  9124. except asyncio.CancelledError:
  9125. break
  9126. except Exception as e:
  9127. logger.warning("Connection watchdog sweep failed: %s", e)
  9128. await asyncio.sleep(CONNECTION_WATCHDOG_INTERVAL)
  9129. def start_connection_watchdog():
  9130. global _connection_watchdog_task
  9131. if _connection_watchdog_task is None:
  9132. _connection_watchdog_task = asyncio.create_task(_connection_watchdog_loop())
  9133. logging.getLogger(__name__).info("Printer connection watchdog started")
  9134. def stop_connection_watchdog():
  9135. global _connection_watchdog_task
  9136. if _connection_watchdog_task:
  9137. _connection_watchdog_task.cancel()
  9138. _connection_watchdog_task = None
  9139. _connection_watchdog_last_attempt.clear()
  9140. logging.getLogger(__name__).info("Printer connection watchdog stopped")
  9141. # Camera stream orphan cleanup
  9142. _camera_cleanup_task: asyncio.Task | None = None
  9143. CAMERA_CLEANUP_INTERVAL = 60
  9144. # Every this many camera cleanups (about an hour), the timelapse janitor too:
  9145. # kept frames of a failed stitch go after a day, not at the next restart.
  9146. TIMELAPSE_CLEANUP_EVERY = 60
  9147. async def _camera_cleanup_loop():
  9148. """Periodically clean up orphaned ffmpeg processes and timelapse leftovers."""
  9149. from backend.app.api.routes.camera import cleanup_orphaned_streams
  9150. from backend.app.services.layer_timelapse import cleanup_orphaned_timelapse_sessions
  9151. rounds = 0
  9152. while True:
  9153. try:
  9154. rounds += 1
  9155. await cleanup_orphaned_streams()
  9156. except asyncio.CancelledError:
  9157. break
  9158. except Exception as e:
  9159. logging.getLogger(__name__).warning("Camera stream cleanup failed: %s", e)
  9160. try:
  9161. if rounds % TIMELAPSE_CLEANUP_EVERY == 0:
  9162. await asyncio.to_thread(cleanup_orphaned_timelapse_sessions)
  9163. except asyncio.CancelledError:
  9164. break
  9165. except Exception as e:
  9166. logging.getLogger(__name__).warning("Timelapse frames cleanup failed: %s", e)
  9167. await asyncio.sleep(CAMERA_CLEANUP_INTERVAL)
  9168. def start_camera_cleanup():
  9169. global _camera_cleanup_task
  9170. if _camera_cleanup_task is None:
  9171. _camera_cleanup_task = asyncio.create_task(_camera_cleanup_loop())
  9172. logging.getLogger(__name__).info("Camera stream cleanup started")
  9173. def stop_camera_cleanup():
  9174. global _camera_cleanup_task
  9175. if _camera_cleanup_task:
  9176. _camera_cleanup_task.cancel()
  9177. _camera_cleanup_task = None
  9178. logging.getLogger(__name__).info("Camera stream cleanup stopped")
  9179. # ---------------------------------------------------------------------------
  9180. # Expected-print TTL eviction
  9181. # ---------------------------------------------------------------------------
  9182. def _evict_stale_expected_prints() -> None:
  9183. """Remove entries from _expected_prints / _expected_print_creators that are
  9184. older than _EXPECTED_PRINT_TTL_SECONDS.
  9185. This prevents unbounded growth when a print is registered (via
  9186. register_expected_print) but on_print_start never fires — e.g. because the
  9187. printer disconnects, the app restarts, or the print is started directly from
  9188. the printer panel without going through the queue.
  9189. """
  9190. # Use monotonic time so the TTL is unaffected by system clock adjustments
  9191. # (e.g. NTP sync, DST changes).
  9192. # A print that ended without its archive being found at completion leaves
  9193. # its id here; only running prints are owned.
  9194. _owned_print_archive_ids.intersection_update(_active_prints.values())
  9195. cutoff = time.monotonic() - _EXPECTED_PRINT_TTL_SECONDS
  9196. stale_keys = [k for k, t in _expected_print_registered_at.items() if t < cutoff]
  9197. if not stale_keys:
  9198. return
  9199. evicted_archive_ids: set[int] = set()
  9200. for key in stale_keys:
  9201. archive_id = _expected_prints.pop(key, None)
  9202. if archive_id is not None:
  9203. evicted_archive_ids.add(archive_id)
  9204. _expected_print_creators.pop(key, None)
  9205. _expected_print_registered_at.pop(key, None)
  9206. # Also clean up _print_ams_mappings and _print_plate_ids for archive_ids
  9207. # that have no remaining live keys in _expected_prints (all variants
  9208. # were just evicted) and are not printing right now. Print start pops
  9209. # only the names the printer reported, so the "<base>.gcode" variant
  9210. # outlives it; without the printing check its eviction two hours after
  9211. # dispatch threw away a running print's plate, AMS mapping and cost
  9212. # centre, which completion still reads (#3275).
  9213. live_archive_ids = set(_expected_prints.values()) | set(_active_prints.values())
  9214. for archive_id in evicted_archive_ids:
  9215. if archive_id not in live_archive_ids:
  9216. _print_ams_mappings.pop(archive_id, None)
  9217. _print_cost_center_ids.pop(archive_id, None)
  9218. _print_plate_ids.pop(archive_id, None)
  9219. logging.getLogger(__name__).info(
  9220. "Evicted %d stale expected-print entries (TTL=%ds)", len(stale_keys), _EXPECTED_PRINT_TTL_SECONDS
  9221. )
  9222. async def _expected_prints_cleanup_loop() -> None:
  9223. """Background task: periodically evict stale expected-print entries."""
  9224. while True:
  9225. try:
  9226. _evict_stale_expected_prints()
  9227. except asyncio.CancelledError:
  9228. raise
  9229. except Exception as e:
  9230. logging.getLogger(__name__).warning("Expected prints cleanup failed: %s", e)
  9231. await asyncio.sleep(_EXPECTED_PRINT_CLEANUP_INTERVAL)
  9232. def start_expected_prints_cleanup() -> None:
  9233. global _expected_prints_cleanup_task
  9234. if _expected_prints_cleanup_task is None:
  9235. _expected_prints_cleanup_task = asyncio.create_task(_expected_prints_cleanup_loop())
  9236. logging.getLogger(__name__).info("Expected prints cleanup started")
  9237. def stop_expected_prints_cleanup() -> None:
  9238. global _expected_prints_cleanup_task
  9239. if _expected_prints_cleanup_task:
  9240. _expected_prints_cleanup_task.cancel()
  9241. _expected_prints_cleanup_task = None
  9242. logging.getLogger(__name__).info("Expected prints cleanup stopped")
  9243. # ---------------------------------------------------------------------------
  9244. # L-2: Periodic auth-token cleanup (stale TOTP + expired revoked JTIs)
  9245. # ---------------------------------------------------------------------------
  9246. _auth_cleanup_task: asyncio.Task | None = None
  9247. _AUTH_CLEANUP_INTERVAL = 3600 # seconds (hourly)
  9248. async def _run_auth_cleanup() -> None:
  9249. """Single cleanup pass: remove stale TOTP records, expired revoked JTIs, and old rate-limit events."""
  9250. from backend.app.core.database import async_session
  9251. from backend.app.models.auth_ephemeral import AuthEphemeralToken, AuthRateLimitEvent
  9252. from backend.app.models.user_totp import UserTOTP
  9253. now = datetime.now(timezone.utc)
  9254. # Remove unconfirmed (is_enabled=False) TOTP records older than 1 hour.
  9255. try:
  9256. async with async_session() as db:
  9257. stale_cutoff = now - timedelta(hours=1)
  9258. result = await db.execute(
  9259. select(UserTOTP).where(
  9260. UserTOTP.is_enabled.is_(False),
  9261. UserTOTP.created_at < stale_cutoff,
  9262. )
  9263. )
  9264. stale_records = result.scalars().all()
  9265. if stale_records:
  9266. for rec in stale_records:
  9267. await db.delete(rec)
  9268. await db.commit()
  9269. logging.info("Auth cleanup: removed %d stale unconfirmed TOTP record(s)", len(stale_records))
  9270. except Exception as e:
  9271. logging.warning("Auth cleanup: failed to purge stale TOTP records: %s", e)
  9272. # Remove expired revoked-JTI entries (they are no longer needed once the
  9273. # original token's exp has passed — the token would be rejected by JWT
  9274. # signature verification regardless).
  9275. try:
  9276. async with async_session() as db:
  9277. await db.execute(
  9278. delete(AuthEphemeralToken).where(
  9279. AuthEphemeralToken.token_type == "revoked_jti",
  9280. AuthEphemeralToken.expires_at < now,
  9281. )
  9282. )
  9283. await db.commit()
  9284. except Exception as e:
  9285. logging.warning("Auth cleanup: failed to purge expired revoked JTIs: %s", e)
  9286. # L-R6-B: Purge AuthRateLimitEvent rows older than the lockout window (15 min).
  9287. # Events outside this window can never affect rate-limit decisions — they only
  9288. # consume DB space. Use the same window constant as the rate limiter so the
  9289. # two are always in sync.
  9290. try:
  9291. from backend.app.api.routes.mfa import LOCKOUT_WINDOW
  9292. async with async_session() as db:
  9293. await db.execute(
  9294. delete(AuthRateLimitEvent).where(
  9295. AuthRateLimitEvent.occurred_at < now - LOCKOUT_WINDOW,
  9296. )
  9297. )
  9298. await db.commit()
  9299. except Exception as e:
  9300. logging.warning("Auth cleanup: failed to purge stale rate-limit events: %s", e)
  9301. async def _auth_cleanup_loop() -> None:
  9302. """Periodic background task: run auth cleanup every hour."""
  9303. while True:
  9304. try:
  9305. await _run_auth_cleanup()
  9306. except asyncio.CancelledError:
  9307. break
  9308. except Exception as e:
  9309. logging.warning("Auth cleanup loop error: %s", e)
  9310. await asyncio.sleep(_AUTH_CLEANUP_INTERVAL)
  9311. def start_auth_cleanup() -> None:
  9312. global _auth_cleanup_task
  9313. if _auth_cleanup_task is None:
  9314. _auth_cleanup_task = asyncio.create_task(_auth_cleanup_loop())
  9315. logging.getLogger(__name__).info("Auth periodic cleanup started")
  9316. def stop_auth_cleanup() -> None:
  9317. global _auth_cleanup_task
  9318. if _auth_cleanup_task:
  9319. _auth_cleanup_task.cancel()
  9320. _auth_cleanup_task = None
  9321. logging.getLogger(__name__).info("Auth periodic cleanup stopped")
  9322. @asynccontextmanager
  9323. async def lifespan(app: FastAPI):
  9324. # Startup
  9325. # Install Windows-only asyncio Proactor cleanup-RST filter (#1113) before
  9326. # anything else can spawn tasks that might trip it.
  9327. from backend.app.core.asyncio_handlers import install_proactor_reset_filter, warn_if_running_on_uvloop
  9328. install_proactor_reset_filter()
  9329. # Before anything opens files or sockets in bulk: a soft limit of 1024 is
  9330. # what turned descriptor exhaustion into a corrupted database (#2883).
  9331. from backend.app.core.fd_limit import raise_open_file_limit
  9332. raise_open_file_limit()
  9333. # Before init_db, so the warning is near the top of the log rather than
  9334. # below a migration run. See warn_if_running_on_uvloop for what is at stake.
  9335. warn_if_running_on_uvloop()
  9336. await init_db()
  9337. # Browser download tokens expire after five minutes. Remove abandoned
  9338. # prepared ZIPs at startup as well as before each new preparation so a
  9339. # quiet appliance cannot retain an unusable bundle indefinitely.
  9340. try:
  9341. from backend.app.services.printer_media import prune_stale_printer_file_bundles
  9342. await prune_stale_printer_file_bundles()
  9343. except Exception as exc:
  9344. logging.warning("Failed to prune stale printer download bundles: %s", exc)
  9345. # After migrations, so the is_env_managed column exists. Never raises --
  9346. # a bad BAMBUDDY_OIDC_* value is logged and skipped rather than blocking
  9347. # startup (see apply_env_oidc_provider).
  9348. from backend.app.core.oidc_env import apply_env_oidc_provider
  9349. async with async_session() as oidc_db:
  9350. await apply_env_oidc_provider(oidc_db)
  9351. # Close out batches that finished before `completed` was a reachable status
  9352. # (#342). Without this the Batches tab opens on every batch created since
  9353. # the feature shipped, all still marked active. Never blocks startup.
  9354. try:
  9355. from backend.app.services.print_batch import backfill_batch_statuses
  9356. async with async_session() as batch_db:
  9357. await backfill_batch_statuses(batch_db)
  9358. except Exception as exc:
  9359. logging.warning("[BATCH] Startup status backfill failed: %s", exc)
  9360. # Register an app-scoped httpx client for Bambu Cloud services so
  9361. # per-request BambuCloudService instances reuse the same connection pool
  9362. # (important for routes like /cloud/filament-info that chain many
  9363. # get_setting_detail calls). The shared client stores no region/token
  9364. # state, so the per-request ownership pattern that fixed the region-bleed
  9365. # bug is preserved.
  9366. import httpx as _httpx
  9367. from backend.app.services.bambu_cloud import set_shared_http_client
  9368. from backend.app.services.model_providers.makerworld.service import (
  9369. set_shared_http_client as set_shared_makerworld_http_client,
  9370. )
  9371. from backend.app.services.orca_cloud import (
  9372. set_shared_http_client as set_shared_orca_http_client,
  9373. )
  9374. _shared_cloud_http_client = _httpx.AsyncClient(timeout=30.0)
  9375. set_shared_http_client(_shared_cloud_http_client)
  9376. # Reuse the same connection pool for MakerWorld — different host, same
  9377. # keep-alive pool saves a TLS handshake per request.
  9378. set_shared_makerworld_http_client(_shared_cloud_http_client)
  9379. # Same for Orca Cloud — without this the per-request OrcaCloudService()
  9380. # each spun up (and never closed) its own client, leaking sockets.
  9381. set_shared_orca_http_client(_shared_cloud_http_client)
  9382. # Fix queue items stuck with invalid "aborted" status (should be "cancelled").
  9383. # This can happen when a print was cancelled mid-print on versions before this fix.
  9384. try:
  9385. async with async_session() as db:
  9386. from backend.app.models.print_queue import PrintQueueItem
  9387. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.status == "aborted"))
  9388. aborted_items = result.scalars().all()
  9389. if aborted_items:
  9390. for item in aborted_items:
  9391. item.status = "cancelled"
  9392. await db.commit()
  9393. logging.info("Fixed %d queue item(s) with invalid 'aborted' status → 'cancelled'", len(aborted_items))
  9394. except Exception as e:
  9395. logging.warning("Failed to fix aborted queue items: %s", e)
  9396. # Restore debug logging state from previous session
  9397. await init_debug_logging()
  9398. # Set up printer manager callbacks
  9399. loop = asyncio.get_event_loop()
  9400. printer_manager.set_event_loop(loop)
  9401. printer_manager.set_status_change_callback(on_printer_status_change)
  9402. printer_manager.set_print_start_callback(on_print_start)
  9403. printer_manager.set_print_complete_callback(on_print_complete)
  9404. printer_manager.set_print_running_observed_callback(on_print_running_observed)
  9405. printer_manager.set_finish_photo_moment_callback(on_finish_photo_moment)
  9406. printer_manager.set_ams_change_callback(on_ams_change)
  9407. printer_manager.set_fts_inlet_change_callback(on_fts_inlet_change)
  9408. # Rehydrate persisted awaiting-plate-clear gate (#961) so prompts survive restarts
  9409. await printer_manager.load_awaiting_plate_clear_from_db()
  9410. # Layer change callback for external camera timelapse
  9411. async def on_layer_change(printer_id: int, layer_num: int):
  9412. """Capture timelapse frame on layer change + first layer notification."""
  9413. from backend.app.services.layer_timelapse import on_layer_change as tl_layer_change
  9414. await tl_layer_change(printer_id, layer_num)
  9415. # #1867: bank a recent in-print frame so the finish-photo path has a
  9416. # pre-End-G-code image to use instead of a live grab of a swapped plate.
  9417. # #2547 added `on_print_progress` as a second driver — this one alone
  9418. # stops firing once the final layer begins.
  9419. await _maybe_bank_inprint_frame(printer_id, layer_num)
  9420. # First layer complete notification (layer_num >= 2 means layer 1 is done).
  9421. # Gate on actual printing state — Bambu firmware ticks layer_num during
  9422. # the pre-print calibration sequence (homing / mesh-level / bed scan /
  9423. # nozzle clean), so a bare layer_num check can fire minutes before the
  9424. # first real extrusion. We require gcode_state == RUNNING and
  9425. # mc_print_sub_stage in (0 = "Printing", None) so calibration sub-stages
  9426. # (1, 9, 14, ...) are excluded. The window widens to [2, 10] because if
  9427. # the layer counter advanced past 2 during PREPARE, the next on_layer_change
  9428. # edge fires later; _first_layer_notified stays clear until we actually send
  9429. # so a deferred re-evaluation can win. See issue #1837.
  9430. if 2 <= layer_num <= 10 and not _first_layer_notified.get(printer_id, False):
  9431. client = printer_manager.get_client(printer_id)
  9432. state = client.state if client else None
  9433. if not state or state.state != "RUNNING":
  9434. return
  9435. if state.mc_print_sub_stage not in (None, 0):
  9436. return
  9437. _first_layer_notified[printer_id] = True
  9438. try:
  9439. async with async_session() as db:
  9440. from backend.app.models.printer import Printer
  9441. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  9442. printer = result.scalar_one_or_none()
  9443. if not printer:
  9444. return
  9445. printer_name = printer.name
  9446. filename = (state.subtask_name or state.gcode_file or "Unknown") if state else "Unknown"
  9447. total_layers = state.total_layers if state else 0
  9448. image_data = await _capture_snapshot_for_notification(
  9449. printer_id, printer, logging.getLogger(__name__)
  9450. )
  9451. await notification_service.on_first_layer_complete(
  9452. printer_id, printer_name, filename, total_layers, db, image_data=image_data
  9453. )
  9454. except Exception as e:
  9455. logging.getLogger(__name__).warning("First layer notification failed: %s", e)
  9456. printer_manager.set_layer_change_callback(on_layer_change)
  9457. async def on_print_progress(printer_id: int, percent: int):
  9458. """#2547: keep the in-print frame bank fresh through the final layer.
  9459. `on_layer_change` stops the moment the last layer starts, which on the
  9460. H2C capture that closed #2547 left the bank stale for the three minutes
  9461. that layer took. Progress is the only field that keeps advancing there,
  9462. and it freezes before the End G-code runs — so banking on it stays
  9463. inside the print and never sees a swapped plate.
  9464. """
  9465. client = printer_manager.get_client(printer_id)
  9466. state = client.state if client else None
  9467. await _maybe_bank_inprint_frame(printer_id, state.layer_num if state else 0)
  9468. printer_manager.set_print_progress_callback(on_print_progress)
  9469. # Event-driven bed cooldown: fires whenever bed_temper arrives via MQTT
  9470. async def on_bed_temp_update(printer_id: int, bed_temp: float):
  9471. waiter = _bed_cool_waiters.get(printer_id)
  9472. if not waiter:
  9473. return
  9474. threshold = waiter["threshold"]
  9475. if bed_temp > threshold:
  9476. return
  9477. # Bed is at or below threshold — fire notification and remove waiter
  9478. waiter_info = _bed_cool_waiters.pop(printer_id, None)
  9479. if not waiter_info:
  9480. return # Another callback already handled it
  9481. bed_cool_logger = logging.getLogger(__name__)
  9482. bed_cool_logger.info(
  9483. "[BED-COOL] Bed cooled to %.1f°C on printer %s (threshold: %.0f°C)",
  9484. bed_temp,
  9485. printer_id,
  9486. threshold,
  9487. )
  9488. try:
  9489. printer_info = printer_manager.get_printer(printer_id)
  9490. p_name = printer_info.name if printer_info else "Unknown"
  9491. async with async_session() as db:
  9492. await notification_service.on_bed_cooled(
  9493. printer_id=printer_id,
  9494. printer_name=p_name,
  9495. bed_temp=bed_temp,
  9496. threshold=threshold,
  9497. filename=waiter_info["filename"],
  9498. db=db,
  9499. )
  9500. except Exception as e:
  9501. bed_cool_logger.warning("[BED-COOL] Failed to send notification: %s", e)
  9502. printer_manager.set_bed_temp_update_callback(on_bed_temp_update)
  9503. async def on_drying_complete(printer_id: int, ams_id: int):
  9504. """Smart-plug auto-off-after-drying trigger (#1349).
  9505. Fires once per AMS unit when ``dry_time`` falls from >0 to 0. The
  9506. manager walks all plugs linked to this printer and turns off only
  9507. the ones with ``auto_off_after_drying`` enabled, after their
  9508. per-plug delay. Multiple AMS units finishing close together (e.g. a
  9509. dual-AMS dry that ends within the same MQTT push) call this once
  9510. per unit — the manager's ``_cancel_pending_off`` collapses
  9511. repeated scheduling on the same plug to one timer, so duplicate
  9512. fires are safe.
  9513. """
  9514. try:
  9515. async with async_session() as db:
  9516. await smart_plug_manager.on_drying_complete(printer_id, db)
  9517. except Exception as e:
  9518. logging.getLogger(__name__).warning(
  9519. "Failed to schedule auto-off-after-drying for printer %d (AMS %d): %s",
  9520. printer_id,
  9521. ams_id,
  9522. e,
  9523. )
  9524. printer_manager.set_drying_complete_callback(on_drying_complete)
  9525. async def on_drying_cycle_end(printer_id: int, cycle):
  9526. """Mark the spools in an AMS that just finished drying as dried (#2863)."""
  9527. from backend.app.services.spool_drying import record_drying_cycle
  9528. try:
  9529. async with async_session() as db:
  9530. await record_drying_cycle(db, printer_id, cycle)
  9531. except Exception as e:
  9532. logging.getLogger(__name__).warning(
  9533. "Failed to record drying for printer %d (AMS %d): %s",
  9534. printer_id,
  9535. cycle.ams_id,
  9536. e,
  9537. )
  9538. printer_manager.set_drying_cycle_end_callback(on_drying_cycle_end)
  9539. async def on_assignment_verified(printer_id: int, ams_id: int, tray_id: int, verified: bool, detail: dict):
  9540. """Surface the read-back result of a spool assignment to the UI (#2582).
  9541. The MQTT client confirms (or fails to confirm) that the tray telemetry
  9542. echoed back the filament id we pushed. We relay that as a websocket
  9543. event so the frontend can toast "loaded" / "assignment didn't take"
  9544. instead of the historic silent fire-and-forget, which made the
  9545. AMS→Studio hand-off feel random to users.
  9546. """
  9547. try:
  9548. from backend.app.services.spool_assignment_notifications import (
  9549. _slot_label_from_global_tray,
  9550. )
  9551. if ams_id == 255:
  9552. global_id = 254 + tray_id
  9553. elif ams_id >= 128:
  9554. global_id = ams_id
  9555. else:
  9556. global_id = ams_id * 4 + tray_id
  9557. slot_label = _slot_label_from_global_tray(global_id)
  9558. printer_info = printer_manager.get_printer(printer_id)
  9559. printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
  9560. await ws_manager.broadcast(
  9561. {
  9562. "type": "spool_assignment_verified",
  9563. "printer_id": printer_id,
  9564. "printer_name": printer_name,
  9565. "ams_id": ams_id,
  9566. "tray_id": tray_id,
  9567. "slot": slot_label,
  9568. "verified": verified,
  9569. # Present on success: False means the filament setting landed
  9570. # but the K-profile (cali_idx) did not — the reporter's exact
  9571. # "loaded but no flow profile" symptom.
  9572. "kprofile_applied": detail.get("kprofile_applied", True),
  9573. # Present on failure: whether any tray telemetry was seen in
  9574. # the window (distinguishes "printer silent" from "printer
  9575. # stored something else").
  9576. "saw_tray": detail.get("saw_tray", False),
  9577. }
  9578. )
  9579. except Exception as e:
  9580. logging.getLogger(__name__).warning(
  9581. "Failed to broadcast assignment verification for printer %d AMS%d-T%d: %s",
  9582. printer_id,
  9583. ams_id,
  9584. tray_id,
  9585. e,
  9586. )
  9587. printer_manager.set_assignment_verified_callback(on_assignment_verified)
  9588. async def on_tray_change(printer_id: int, tray_global: int, layer_num: int):
  9589. """Persist a mid-print tray change for completion-time attribution.
  9590. AMS filament backup switches trays without telling the slicer, so the
  9591. tray-change log is the only record of which spool fed which layers.
  9592. Keeping it only in memory meant a restart mid-print charged everything
  9593. to the tray that finished the job.
  9594. """
  9595. try:
  9596. from backend.app.services.usage_tracker import record_tray_change
  9597. async with async_session() as db:
  9598. await record_tray_change(db, printer_id, tray_global, layer_num)
  9599. except Exception as e:
  9600. logging.getLogger(__name__).warning(
  9601. "Failed to persist tray change for printer %d (tray=%d, layer=%d): %s",
  9602. printer_id,
  9603. tray_global,
  9604. layer_num,
  9605. e,
  9606. )
  9607. printer_manager.set_tray_change_callback(on_tray_change)
  9608. # Initialize MQTT relay from settings
  9609. async with async_session() as db:
  9610. from backend.app.api.routes.settings import get_setting
  9611. mqtt_settings = {
  9612. "mqtt_enabled": (await get_setting(db, "mqtt_enabled") or "false") == "true",
  9613. "mqtt_broker": await get_setting(db, "mqtt_broker") or "",
  9614. "mqtt_port": int(await get_setting(db, "mqtt_port") or "1883"),
  9615. "mqtt_username": await get_setting(db, "mqtt_username") or "",
  9616. "mqtt_password": await get_setting(db, "mqtt_password") or "",
  9617. "mqtt_topic_prefix": await get_setting(db, "mqtt_topic_prefix") or "bambuddy",
  9618. "mqtt_use_tls": (await get_setting(db, "mqtt_use_tls") or "false") == "true",
  9619. }
  9620. await mqtt_relay.configure(mqtt_settings)
  9621. # Restore MQTT smart plug subscriptions
  9622. if mqtt_settings.get("mqtt_enabled"):
  9623. from backend.app.models.smart_plug import SmartPlug
  9624. from backend.app.services.mqtt_smart_plug import subscribe_plug_to_mqtt
  9625. result = await db.execute(select(SmartPlug).where(SmartPlug.plug_type == "mqtt"))
  9626. mqtt_plugs = result.scalars().all()
  9627. restored = 0
  9628. for plug in mqtt_plugs:
  9629. if subscribe_plug_to_mqtt(mqtt_relay.smart_plug_service, plug):
  9630. restored += 1
  9631. if restored:
  9632. logging.info("Restored %s MQTT smart plug subscriptions", restored)
  9633. # Connect to all active printers
  9634. async with async_session() as db:
  9635. await init_printer_connections(db)
  9636. # Auto-connect to Spoolman if enabled
  9637. async with async_session() as db:
  9638. from backend.app.api.routes.settings import get_setting
  9639. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  9640. spoolman_url = await get_setting(db, "spoolman_url")
  9641. if spoolman_enabled and spoolman_enabled.lower() == "true" and spoolman_url:
  9642. try:
  9643. client = await init_spoolman_client(spoolman_url)
  9644. if await client.health_check():
  9645. logging.info("Auto-connected to Spoolman at %s", spoolman_url)
  9646. # Ensure the 'tag' extra field exists for RFID/UUID storage
  9647. field_ok = await client.ensure_tag_extra_field()
  9648. if not field_ok:
  9649. logging.error("Spoolman tag extra field registration failed — NFC tag links may not persist")
  9650. # Register the BambuStudio slicer-preset fields used by the
  9651. # spool-edit / assign flow. Spoolman rejects PATCHes with
  9652. # unknown extra keys, so these must exist before any update
  9653. # that touches them.
  9654. for field_name in ("bambu_slicer_filament", "bambu_slicer_filament_name"):
  9655. if not await client.ensure_extra_field(field_name):
  9656. logging.warning(
  9657. "Spoolman extra field %r registration failed — "
  9658. "spool slicer-preset edits will return 502",
  9659. field_name,
  9660. )
  9661. else:
  9662. logging.warning("Spoolman at %s is not reachable", spoolman_url)
  9663. except Exception as e:
  9664. logging.warning("Failed to auto-connect to Spoolman: %s", e)
  9665. # Start the print scheduler
  9666. spawn_background_task(print_scheduler.run(), name="print-scheduler")
  9667. # Start the smart plug scheduler for time-based on/off
  9668. smart_plug_manager.start_scheduler()
  9669. # Start the Home Assistant sensor poller (#1148)
  9670. ha_sensor_manager.start()
  9671. location_ha_sensor_manager.start()
  9672. # Resume any pending auto-offs that were interrupted by restart
  9673. await smart_plug_manager.resume_pending_auto_offs()
  9674. # Start the notification digest scheduler
  9675. notification_service.start_digest_scheduler()
  9676. notify_live_activities.start()
  9677. notify_widgets.start()
  9678. # Start the Telegram reaction pollers (#3046), one per bot token used by a
  9679. # provider in reactions/both mode; the notification routes resync them.
  9680. # Never fatal: a bad provider row or a DB hiccup here costs reactions
  9681. # until the next provider save, not the whole startup.
  9682. try:
  9683. await telegram_reaction_poller.start()
  9684. except Exception as e:
  9685. logging.warning("Telegram reaction poller did not start: %s", e)
  9686. # Start the GitHub backup scheduler
  9687. await github_backup_service.start_scheduler()
  9688. # Start the local backup scheduler
  9689. await local_backup_service.start_scheduler()
  9690. await obico_detection_service.start()
  9691. # Start the library trash sweeper (#1008)
  9692. await library_trash_service.start_scheduler()
  9693. # Start the archive auto-purge sweeper (#1008 follow-up)
  9694. await archive_purge_service.start_scheduler()
  9695. # Start AMS history recording
  9696. start_ams_history_recording()
  9697. # Start printer sensor (nozzle / bed / chamber) history recording
  9698. start_printer_sensor_history_recording()
  9699. # Start printer runtime tracking
  9700. start_runtime_tracking()
  9701. # Start SpoolBuddy device watchdog
  9702. start_spoolbuddy_watchdog()
  9703. # Start camera stream orphan cleanup
  9704. start_camera_cleanup()
  9705. # Start the backstop for MQTT sessions paho has stopped recovering (#2732)
  9706. start_connection_watchdog()
  9707. # One-shot sweep for timelapse session directories orphaned by a crash
  9708. # or restart that happened mid-print (in-memory session tracking can't
  9709. # survive that, and nothing else reaps the leftover frames/output file)
  9710. try:
  9711. from backend.app.services.layer_timelapse import cleanup_orphaned_timelapse_sessions
  9712. removed = cleanup_orphaned_timelapse_sessions()
  9713. if removed:
  9714. logging.getLogger(__name__).info("Removed %d orphaned timelapse session artifact(s)", removed)
  9715. except Exception as e:
  9716. logging.getLogger(__name__).warning("Orphaned timelapse session cleanup failed: %s", e)
  9717. # Start expected-print TTL eviction (prevents memory leak when prints are
  9718. # registered but on_print_start never fires)
  9719. start_expected_prints_cleanup()
  9720. # L-2: Start periodic auth cleanup (stale TOTP + expired revoked JTIs)
  9721. start_auth_cleanup()
  9722. # Maintainer announcements: a signed feed fetched from GitHub every few hours.
  9723. from backend.app.services import announcements as announcements_service
  9724. announcements_service.start()
  9725. from backend.app.services.printer_media import start_printer_download_cleanup
  9726. start_printer_download_cleanup()
  9727. # Event-loop stall watchdog: dumps all thread stacks to stderr if the loop
  9728. # freezes (#1486 — silent "container hangs after adding a printer" reports).
  9729. from backend.app.services.loop_watchdog import start_loop_watchdog
  9730. start_loop_watchdog()
  9731. # Initialize virtual printer manager and sync from DB
  9732. from backend.app.services.virtual_printer import virtual_printer_manager
  9733. virtual_printer_manager.set_session_factory(async_session)
  9734. virtual_printer_manager.set_printer_manager(printer_manager)
  9735. try:
  9736. await virtual_printer_manager.sync_from_db()
  9737. logging.info("Virtual printer manager synced from database")
  9738. except Exception as e:
  9739. logging.warning("Failed to sync virtual printers: %s", e)
  9740. yield
  9741. # Shutdown
  9742. print_scheduler.stop()
  9743. smart_plug_manager.stop_scheduler()
  9744. ha_sensor_manager.stop()
  9745. location_ha_sensor_manager.stop()
  9746. notification_service.stop_digest_scheduler()
  9747. await notify_live_activities.close()
  9748. await notify_widgets.close()
  9749. await telegram_reaction_poller.aclose()
  9750. github_backup_service.stop_scheduler()
  9751. local_backup_service.stop_scheduler()
  9752. library_trash_service.stop_scheduler()
  9753. archive_purge_service.stop_scheduler()
  9754. obico_detection_service.stop()
  9755. stop_ams_history_recording()
  9756. stop_printer_sensor_history_recording()
  9757. stop_runtime_tracking()
  9758. stop_spoolbuddy_watchdog()
  9759. stop_camera_cleanup()
  9760. stop_connection_watchdog()
  9761. from backend.app.services.loop_watchdog import stop_loop_watchdog
  9762. stop_loop_watchdog()
  9763. # Tear down all camera fan-out broadcasters (#1089) so subscribers exit
  9764. # cleanly rather than waiting on a queue that nothing will ever fill.
  9765. try:
  9766. from backend.app.services.camera_fanout import shutdown_all_broadcasters
  9767. await shutdown_all_broadcasters()
  9768. except Exception as e:
  9769. logging.warning("Failed to shut down camera broadcasters: %s", e)
  9770. stop_expected_prints_cleanup()
  9771. stop_auth_cleanup()
  9772. from backend.app.services import announcements as announcements_service
  9773. announcements_service.stop()
  9774. from backend.app.services.printer_media import stop_printer_download_cleanup
  9775. await stop_printer_download_cleanup()
  9776. printer_manager.disconnect_all()
  9777. slot_unlink_grace.reset()
  9778. await close_spoolman_client()
  9779. # Stop all virtual printer services
  9780. await virtual_printer_manager.stop_all()
  9781. await mqtt_smart_plug_service.disconnect(timeout=2)
  9782. await mqtt_relay.disconnect(timeout=2)
  9783. # Drop the shared Bambu Cloud HTTP client we registered at startup.
  9784. set_shared_http_client(None)
  9785. set_shared_makerworld_http_client(None)
  9786. set_shared_orca_http_client(None)
  9787. await _shared_cloud_http_client.aclose()
  9788. # Checkpoint WAL (SQLite only) and close all database connections
  9789. from backend.app.core.db_dialect import is_sqlite
  9790. if is_sqlite():
  9791. try:
  9792. async with engine.begin() as conn:
  9793. await conn.execute(text("PRAGMA wal_checkpoint(TRUNCATE)"))
  9794. logging.info("WAL checkpoint completed")
  9795. except Exception as e:
  9796. logging.warning("WAL checkpoint failed: %s", e)
  9797. await engine.dispose()
  9798. app = FastAPI(
  9799. title=app_settings.app_name,
  9800. description="Archive and manage Bambu Lab 3MF files",
  9801. version=APP_VERSION,
  9802. lifespan=lifespan,
  9803. )
  9804. # Added first so it sits innermost, next to the routes: a refused header's value
  9805. # (often a stored token) masked in every JSON body. See core.response_redaction.
  9806. app.add_middleware(RefusedHeaderResponseMask)
  9807. # =============================================================================
  9808. # Authentication Middleware - Secures ALL API routes by default
  9809. # =============================================================================
  9810. # Public routes that don't require authentication even when auth is enabled
  9811. PUBLIC_API_ROUTES = {
  9812. # Auth routes needed before/during login
  9813. "/api/v1/auth/status",
  9814. "/api/v1/auth/login",
  9815. "/api/v1/auth/setup", # Needed for initial setup and recovery
  9816. # Advanced auth status needed for login page
  9817. "/api/v1/auth/advanced-auth/status",
  9818. "/api/v1/auth/forgot-password", # Password reset for advanced auth
  9819. "/api/v1/auth/forgot-password/confirm", # Complete password reset with token (H-6)
  9820. # 2FA routes that are called BEFORE a JWT is issued (pre-auth flow)
  9821. "/api/v1/auth/2fa/verify", # Exchange pre_auth_token + 2FA code for JWT
  9822. "/api/v1/auth/2fa/email/send", # Send OTP email (pre_auth_token based)
  9823. # OIDC routes that must be reachable without a JWT
  9824. "/api/v1/auth/oidc/providers", # Public list of enabled providers
  9825. "/api/v1/auth/oidc/callback", # Redirect target from OIDC provider
  9826. "/api/v1/auth/oidc/exchange", # Exchange short-lived OIDC token for JWT
  9827. # Connected apps: the app's server swaps a code for the user's identity,
  9828. # authenticated by its client secret rather than a login token.
  9829. "/api/v1/connect/token",
  9830. # Version check for updates (no sensitive data)
  9831. "/api/v1/updates/version",
  9832. # Metrics endpoint handles its own prometheus_token authentication
  9833. "/api/v1/metrics",
  9834. # Appliance bootstrap (#1589 follow-up): the SPA's i18n setup polls
  9835. # this BEFORE a JWT is available to pick up the firstboot wizard's
  9836. # hostname / timezone / locale and the chrony NTP-gate state. The
  9837. # response contains user-set defaults and a public sync flag — no
  9838. # secrets. Without this entry the global auth middleware returns 401
  9839. # before the route handler runs, regardless of the route's own
  9840. # "no auth required" intent.
  9841. "/api/v1/system/appliance",
  9842. # Cam Wall kiosk feed (#2531): a TV or Pi in kiosk mode has no login, so it
  9843. # authenticates with a long-lived ``camwall``-scoped token in the query
  9844. # string — exactly like the camera streams two lists below, and for the same
  9845. # reason (no header to put a JWT in). "Public" here only means the middleware
  9846. # steps aside; the route still runs RequireCamWallTokenIfAuthEnabled, which
  9847. # rejects an absent, expired, revoked, or wrong-scoped token. In particular a
  9848. # plain ``camera_stream`` token does NOT open this door.
  9849. "/api/v1/camwall/printers",
  9850. # Overlay branding: the route enforces overlay-scoped token authentication.
  9851. "/api/v1/overlay-branding/logo",
  9852. }
  9853. # Route prefixes that are public (for routes with dynamic segments)
  9854. PUBLIC_API_PREFIXES = [
  9855. # WebSocket connections handle their own auth
  9856. "/api/v1/ws",
  9857. # OIDC authorize redirects — include provider_id in path
  9858. "/api/v1/auth/oidc/authorize/",
  9859. # One-tap outcome-verdict links from push notifications (#1898). Tapped on
  9860. # a phone with no session, so no header can carry a JWT — the single-use
  9861. # capability token in the path IS the credential (same reasoning as the
  9862. # /dl/ slicer downloads below). The route grants nothing beyond writing
  9863. # good/reject on the one archive the token was minted for.
  9864. "/api/v1/archives/confirm/",
  9865. ]
  9866. # Route patterns that are public (read-only display data)
  9867. # These are checked with "in path" - needed because browsers load images/videos
  9868. # via <img src> and <video src> which don't include Authorization headers
  9869. PUBLIC_API_PATTERNS = [
  9870. # Thumbnails
  9871. "/thumbnail", # /archives/{id}/thumbnail, /library/files/{id}/thumbnail
  9872. "/plate-thumbnail/", # /archives/{id}/plate-thumbnail/{plate_id}
  9873. # Images and media
  9874. "/photos/", # /archives/{id}/photos/{filename}
  9875. "/project-image/", # /archives/{id}/project-image/{path}
  9876. "/qrcode", # /archives/{id}/qrcode
  9877. "/timelapse", # /archives/{id}/timelapse (video)
  9878. "/cover", # /printers/{id}/cover
  9879. "/icon", # /external-links/{id}/icon
  9880. # Camera (streams loaded via <img> tag)
  9881. "/camera/stream", # /printers/{id}/camera/stream
  9882. "/camera/snapshot", # /printers/{id}/camera/snapshot
  9883. # Streaming-overlay status feed (#2613): OBS loads /overlay/{id} with no login
  9884. # and this backs it, authenticated by an ``overlay``-scoped token in the query
  9885. # string (same reasoning as the camera streams above — no header to carry a
  9886. # JWT). "Public" only means the middleware steps aside; the route still runs
  9887. # RequireOverlayTokenIfAuthEnabled, which rejects an absent, expired, revoked,
  9888. # or wrong-scoped token — a camwall or camera_stream token does NOT open it.
  9889. "/overlay-status", # /printers/{id}/overlay-status
  9890. # Slicer token-authenticated downloads — protocol handlers (bambustudioopen://,
  9891. # orcaslicer://) cannot send auth headers. These endpoints validate a short-lived
  9892. # download token in the URL path instead.
  9893. "/dl/", # /archives/{id}/dl/{token}/{filename}, /library/files/{id}/dl/{token}/{filename}
  9894. # Same family, but the segment is "source-dl" — which does NOT contain "/dl/",
  9895. # and these patterns match by substring. Without its own entry the middleware
  9896. # 401s the slicer's header-less request before the route's token check runs,
  9897. # so "Open source 3MF in slicer" failed whenever auth was enabled (#3029).
  9898. "/source-dl/", # /archives/{id}/source-dl/{token}/{filename}
  9899. # Obico ML API fetches JPEG frames by one-shot nonce (issue #172 follow-up).
  9900. # The nonce itself is the credential: 32-byte random, single-use, ~30s TTL.
  9901. "/obico/cached-frame/", # /obico/cached-frame/{nonce}
  9902. ]
  9903. _security_headers_logger = logging.getLogger("backend.app.main.security_headers")
  9904. def _parse_trusted_frame_origins() -> tuple[str, ...]:
  9905. """Parse TRUSTED_FRAME_ORIGINS env var into a validated allowlist (#1191).
  9906. Format: comma-separated list of ``scheme://host[:port]`` origins.
  9907. Used by ``security_headers_middleware`` to relax ``frame-ancestors`` for
  9908. trusted same-LAN deployments (e.g. Home Assistant Webpage panel embedding
  9909. Bambuddy from a different port). Defaults to empty — strict ``'none'``.
  9910. Invalid entries are dropped with a warning rather than failing startup, so
  9911. a typo in one origin doesn't take the whole deployment down.
  9912. """
  9913. raw = os.environ.get("TRUSTED_FRAME_ORIGINS", "").strip()
  9914. if not raw:
  9915. return ()
  9916. valid: list[str] = []
  9917. for item in raw.split(","):
  9918. candidate = item.strip()
  9919. if not candidate:
  9920. continue
  9921. try:
  9922. parsed = urlparse(candidate)
  9923. except ValueError as e:
  9924. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — %s", candidate, e)
  9925. continue
  9926. if parsed.scheme not in ("http", "https"):
  9927. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — must be http(s)", candidate)
  9928. continue
  9929. if not parsed.netloc:
  9930. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — missing host", candidate)
  9931. continue
  9932. if parsed.path and parsed.path != "/":
  9933. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — paths not allowed", candidate)
  9934. continue
  9935. if parsed.query or parsed.fragment:
  9936. _security_headers_logger.warning(
  9937. "TRUSTED_FRAME_ORIGINS: dropping %r — query/fragment not allowed", candidate
  9938. )
  9939. continue
  9940. if "*" in parsed.netloc:
  9941. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — wildcards not allowed", candidate)
  9942. continue
  9943. valid.append(f"{parsed.scheme}://{parsed.netloc}")
  9944. if valid:
  9945. _security_headers_logger.info("TRUSTED_FRAME_ORIGINS: %s", ", ".join(valid))
  9946. return tuple(valid)
  9947. _TRUSTED_FRAME_ORIGINS: tuple[str, ...] = _parse_trusted_frame_origins()
  9948. def _frame_ancestors(default_value: str) -> str:
  9949. """Compose the ``frame-ancestors`` CSP directive (#1191).
  9950. ``default_value`` is the strict directive used when the operator has not
  9951. configured ``TRUSTED_FRAME_ORIGINS`` — typically ``'none'`` (catch-all and
  9952. docs) or ``'self'`` (the streaming overlay, embedded same-origin by the
  9953. Settings URL builder's preview). When trusted origins
  9954. are configured, ``'self'`` is always included so same-origin embedding never
  9955. breaks even if an operator forgets to add their own origin to the list.
  9956. """
  9957. if _TRUSTED_FRAME_ORIGINS:
  9958. return "frame-ancestors 'self' " + " ".join(_TRUSTED_FRAME_ORIGINS) + ";"
  9959. return f"frame-ancestors {default_value};"
  9960. # The two Vite-emitted worker assets that compile WebAssembly (#2976). Both
  9961. # patterns are anchored on the exact emitted name so the relaxed policies
  9962. # below can never apply to any other asset.
  9963. # src/workers/stepPreview.worker.ts -> /assets/stepPreview.worker-<hash>.js
  9964. # pdfjs-dist/legacy/build/pdf.worker.min.mjs?worker&url
  9965. # -> /assets/pdf.worker.min-<hash>.js
  9966. # Vite also emits a one-line chunk under the second name that only exports the
  9967. # worker's URL. The page imports it as a module, and a module script is run
  9968. # under the importing document's policy, never its own response's, so it
  9969. # matching as well changes nothing.
  9970. _STEP_WORKER_ASSET_RE = re.compile(r"^/assets/stepPreview\.worker-[\w-]+\.js$")
  9971. _PDF_WORKER_ASSET_RE = re.compile(r"^/assets/pdf\.worker\.min-[\w-]+\.js$")
  9972. @app.middleware("http")
  9973. async def security_headers_middleware(request, call_next):
  9974. """Add standard HTTP security headers to every response."""
  9975. # Per-request nonce stamped into `script-src` (#1460). On its own this
  9976. # changes nothing for Bambuddy's own pages — index.html has no inline
  9977. # scripts since the SW registration moved to /sw-register.js. The reason
  9978. # it's here is Cloudflare: a CF-fronted deployment has the bot-detection
  9979. # script injected into the HTML on the edge, with a fresh hash on every
  9980. # load (so hashes can't be allowlisted). When CF sees a nonce in our CSP,
  9981. # it clones the same nonce onto its injected <script>, and the inline
  9982. # script passes the policy without us needing 'unsafe-inline'. See
  9983. # https://developers.cloudflare.com/cloudflare-challenges/challenge-types/javascript-detections/#if-you-have-a-content-security-policy-csp
  9984. csp_nonce = secrets.token_urlsafe(16)
  9985. # Routes that render their own HTML need it too, or their inline script is
  9986. # blocked by the policy below. The outcome-confirmation page (#1898) is the
  9987. # one that does: it submits its own form so a verdict still costs one tap.
  9988. request.state.csp_nonce = csp_nonce
  9989. response = await call_next(request)
  9990. response.headers["X-Content-Type-Options"] = "nosniff"
  9991. # X-Frame-Options is the legacy cross-origin embedding control. Modern
  9992. # browsers honour CSP frame-ancestors instead, and the legacy
  9993. # `ALLOW-FROM <url>` syntax is deprecated and inconsistent across vendors.
  9994. # When operators have explicitly allowlisted trusted frame origins (#1191
  9995. # — typically Home Assistant on a different port), drop X-Frame-Options
  9996. # and let the CSP-side frame-ancestors directive govern embedding.
  9997. if not _TRUSTED_FRAME_ORIGINS:
  9998. response.headers["X-Frame-Options"] = "SAMEORIGIN"
  9999. response.headers["Referrer-Policy"] = "strict-origin-when-cross-origin"
  10000. # Content-Security-Policy for the React SPA.
  10001. # Notes:
  10002. # - 'unsafe-inline' for style-src: React and UI libs inject inline styles at runtime.
  10003. # - connect-src ws:/wss:: MQTT/printer WebSocket connections.
  10004. # - img-src data: / blob:: base64 thumbnails and Blob-URL timelapse previews.
  10005. # - media-src blob:: timelapse video player uses Blob URLs.
  10006. # - font-src data:: some icon fonts are embedded as data URIs.
  10007. if request.url.path in ("/docs", "/redoc", "/docs/oauth2-redirect"):
  10008. # FastAPI's built-in Swagger UI / ReDoc pages load assets from
  10009. # cdn.jsdelivr.net and bootstrap with an inline <script>, so the
  10010. # default CSP would render a blank page.
  10011. response.headers["Content-Security-Policy"] = (
  10012. "default-src 'self'; "
  10013. "script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; "
  10014. "style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net https://fonts.googleapis.com; "
  10015. "img-src 'self' data: blob: https://fastapi.tiangolo.com https://cdn.redoc.ly; "
  10016. "connect-src 'self'; "
  10017. "font-src 'self' data: https://fonts.gstatic.com; "
  10018. "worker-src 'self' blob:; "
  10019. "object-src 'none'; "
  10020. "base-uri 'self'; " + _frame_ancestors("'none'")
  10021. )
  10022. elif _STEP_WORKER_ASSET_RE.match(request.url.path):
  10023. # The STEP preview worker (#2976) runs OpenCascade compiled to WASM;
  10024. # its emscripten/embind glue generates invoker functions with `new
  10025. # Function(...)`, which needs 'unsafe-eval'. Per CSP3 a dedicated
  10026. # worker is governed by the policy delivered with the WORKER SCRIPT's
  10027. # own response — not the document's — so relaxing it here confines
  10028. # eval to that DOM-less worker context. The document policy below
  10029. # stays nonce-strict, and this response header has no effect when the
  10030. # file is merely fetched (a fetch's CSP is enforced against the
  10031. # requesting document, not the resource's own headers).
  10032. response.headers["Content-Security-Policy"] = (
  10033. "default-src 'self'; "
  10034. "script-src 'self' 'wasm-unsafe-eval' 'unsafe-eval'; "
  10035. "connect-src 'self'; "
  10036. "object-src 'none'; "
  10037. "base-uri 'self'; " + _frame_ancestors("'none'")
  10038. )
  10039. elif _PDF_WORKER_ASSET_RE.match(request.url.path):
  10040. # pdf.js decodes JPEG2000/JBIG2 images and ICC colour with WebAssembly
  10041. # and fetches those modules from /assets/pdfjs/wasm/ (#2976). Same CSP3
  10042. # rule as the STEP worker above: the policy that governs a dedicated
  10043. # worker is the one delivered with its own script, so the wasm compile
  10044. # has to be permitted here rather than on the document. Unlike the STEP
  10045. # worker this one needs no JS eval, so it gets 'wasm-unsafe-eval' only.
  10046. response.headers["Content-Security-Policy"] = (
  10047. "default-src 'self'; "
  10048. "script-src 'self' 'wasm-unsafe-eval'; "
  10049. "connect-src 'self'; "
  10050. "object-src 'none'; "
  10051. "base-uri 'self'; " + _frame_ancestors("'none'")
  10052. )
  10053. else:
  10054. # The streaming overlay is embedded same-origin by the URL builder's
  10055. # preview in Settings (#1422), so this branch allows 'self'.
  10056. # Embedding from anywhere else is still refused: 'self'
  10057. # only permits a framer on this origin, which is Bambuddy's own UI, so
  10058. # a clickjacking page on another host is blocked exactly as before.
  10059. # (The overlay draws status over a camera feed and its only interactive
  10060. # element is the logo link, so there is nothing to bait a click into
  10061. # even from a same-origin framer.) Cross-origin embedding of the
  10062. # overlay — Home Assistant on another port — remains what
  10063. # TRUSTED_FRAME_ORIGINS is for, and _frame_ancestors already folds that
  10064. # allowlist in.
  10065. #
  10066. # The connected-app consent page (/connect/authorize) gets the same
  10067. # 'self': an app opened from Bambuddy's sidebar runs in an iframe, and
  10068. # its "Sign in with Bambuddy" navigates that iframe to this page. With
  10069. # 'none' the browser refuses to show it even inside Bambuddy. 'self'
  10070. # requires every ancestor to be this origin, so a foreign page -- a
  10071. # sidebar link's site included -- still cannot frame the consent
  10072. # screen to bait a click.
  10073. embeddable_same_origin = request.url.path.startswith("/overlay/") or request.url.path == "/connect/authorize"
  10074. # No 'wasm-unsafe-eval' here: nothing compiles WebAssembly on the main
  10075. # thread. Both wasm consumers — the STEP preview and pdf.js's image
  10076. # decoders (#2976) — run in dedicated workers, which CSP3 governs by
  10077. # the policy served with their own script, so each gets it in its own
  10078. # branch above and the document policy stays as strict as it was.
  10079. response.headers["Content-Security-Policy"] = (
  10080. "default-src 'self'; "
  10081. f"script-src 'self' 'nonce-{csp_nonce}'; "
  10082. "style-src 'self' 'unsafe-inline'; "
  10083. "img-src 'self' data: blob:; "
  10084. "media-src 'self' blob:; "
  10085. "connect-src 'self' ws: wss:; "
  10086. "font-src 'self' data:; "
  10087. "object-src 'none'; "
  10088. "base-uri 'self'; "
  10089. "frame-src 'self' http: https:; " + _frame_ancestors("'self'" if embeddable_same_origin else "'none'")
  10090. )
  10091. if request.url.scheme == "https":
  10092. response.headers["Strict-Transport-Security"] = "max-age=31536000; includeSubDomains"
  10093. return response
  10094. @app.middleware("http")
  10095. async def auth_middleware(request, call_next):
  10096. """Enforce authentication on all API routes when auth is enabled.
  10097. This middleware provides defense-in-depth by checking auth at the API gateway level,
  10098. regardless of whether individual routes have auth dependencies.
  10099. """
  10100. from starlette.responses import JSONResponse
  10101. path = request.url.path
  10102. # Only apply to API routes
  10103. if not path.startswith("/api/"):
  10104. return await call_next(request)
  10105. # Allow public routes
  10106. if path in PUBLIC_API_ROUTES:
  10107. return await call_next(request)
  10108. # Allow public prefixes
  10109. for prefix in PUBLIC_API_PREFIXES:
  10110. if path.startswith(prefix):
  10111. return await call_next(request)
  10112. # Allow public patterns (read-only display data like thumbnails)
  10113. for pattern in PUBLIC_API_PATTERNS:
  10114. if pattern in path:
  10115. return await call_next(request)
  10116. # Check if auth is enabled. Fail CLOSED on any exception during the
  10117. # probe — GHSA-6mf4-q26m-47pv: the previous fail-open path here let
  10118. # an attacker who could force a DB exception (e.g. file-descriptor
  10119. # exhaustion via login flood) bypass auth on every protected endpoint.
  10120. # Only the probe is guarded: the request itself runs outside the try, so an
  10121. # error in a route surfaces as the 500 it is rather than as an auth outage.
  10122. try:
  10123. async with async_session() as db:
  10124. from backend.app.core.auth import is_auth_enabled
  10125. auth_enabled = await is_auth_enabled(db)
  10126. except Exception:
  10127. logging.getLogger(__name__).exception("auth_middleware: failing closed on auth-probe error from %s", path)
  10128. return JSONResponse(
  10129. status_code=503,
  10130. content={"detail": "Authentication service temporarily unavailable"},
  10131. )
  10132. if not auth_enabled:
  10133. # Auth disabled, allow all requests
  10134. return await call_next(request)
  10135. # Auth is enabled - require valid token
  10136. auth_header = request.headers.get("Authorization")
  10137. x_api_key = request.headers.get("X-API-Key")
  10138. # Check for API key auth first
  10139. if x_api_key or (auth_header and auth_header.startswith("Bearer bb_")):
  10140. # API key authentication - let the request through to be validated by route handler
  10141. # API keys are validated per-route since they have different permission levels
  10142. return await call_next(request)
  10143. # Check for JWT auth
  10144. if not auth_header or not auth_header.startswith("Bearer "):
  10145. return JSONResponse(
  10146. status_code=401,
  10147. content={"detail": "Authentication required"},
  10148. headers={"WWW-Authenticate": "Bearer"},
  10149. )
  10150. # Validate JWT token
  10151. import jwt
  10152. try:
  10153. from backend.app.core.auth import (
  10154. ALGORITHM,
  10155. SECRET_KEY,
  10156. _is_token_fresh,
  10157. get_user_by_username,
  10158. is_jti_revoked,
  10159. )
  10160. token = auth_header.replace("Bearer ", "")
  10161. payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
  10162. username = payload.get("sub")
  10163. if not username:
  10164. raise ValueError("No username in token")
  10165. jti = payload.get("jti")
  10166. if not jti:
  10167. raise ValueError("No jti in token")
  10168. iat = payload.get("iat")
  10169. # Verify user exists, is active, and token is still fresh (L-R8-A).
  10170. # Reject revoked tokens first (defense-in-depth gateway check), reusing
  10171. # this session so the gateway adds a single pooled checkout, not two (#2572).
  10172. async with async_session() as db:
  10173. if await is_jti_revoked(jti, db):
  10174. return JSONResponse(
  10175. status_code=401,
  10176. content={"detail": "Token has been revoked"},
  10177. headers={"WWW-Authenticate": "Bearer"},
  10178. )
  10179. user = await get_user_by_username(db, username)
  10180. if not user or not user.is_active:
  10181. return JSONResponse(
  10182. status_code=401,
  10183. content={"detail": "User not found or inactive"},
  10184. headers={"WWW-Authenticate": "Bearer"},
  10185. )
  10186. if not _is_token_fresh(iat, user):
  10187. return JSONResponse(
  10188. status_code=401,
  10189. content={"detail": "Token no longer valid"},
  10190. headers={"WWW-Authenticate": "Bearer"},
  10191. )
  10192. except jwt.ExpiredSignatureError:
  10193. return JSONResponse(
  10194. status_code=401,
  10195. content={"detail": "Token has expired"},
  10196. headers={"WWW-Authenticate": "Bearer"},
  10197. )
  10198. except (jwt.InvalidTokenError, ValueError):
  10199. return JSONResponse(
  10200. status_code=401,
  10201. content={"detail": "Invalid token"},
  10202. headers={"WWW-Authenticate": "Bearer"},
  10203. )
  10204. except Exception:
  10205. # Not a bad token but a failure checking it (database, pool): refuse,
  10206. # as for the probe above, rather than answer 401 -- the frontend reads
  10207. # a 401 from /auth/me as final and signs the user out.
  10208. logging.getLogger(__name__).exception("auth_middleware: failing closed on token-check error from %s", path)
  10209. return JSONResponse(
  10210. status_code=503,
  10211. content={"detail": "Authentication service temporarily unavailable"},
  10212. )
  10213. return await call_next(request)
  10214. @app.middleware("http")
  10215. async def trace_id_middleware(request, call_next):
  10216. """Stamp every HTTP request with a trace ID and echo it back.
  10217. Decorated AFTER auth_middleware on purpose: Starlette stacks
  10218. @app.middleware decorators LIFO, so the last-decorated runs first
  10219. inbound. Putting the trace stamp last makes it the OUTERMOST layer,
  10220. which means auth-middleware log lines (and every line emitted on the
  10221. way down to and back from the route handler) all carry the same
  10222. trace ID. If we put it before auth, auth's logs would be stamped
  10223. with the *previous* request's ID — useless for correlation.
  10224. Honours an inbound ``X-Trace-Id`` header so callers running their
  10225. own tracing can correlate their span IDs with our log lines, but
  10226. only if the value passes the whitelist gate in
  10227. ``backend.app.core.trace.normalise_inbound_trace_id`` — anything
  10228. rejected (too long, contains control chars, etc.) silently triggers
  10229. a freshly minted server-side ID rather than failing the request.
  10230. The minted (or echoed) ID is set on a ContextVar so that every log
  10231. record emitted during the request — application logs *and* uvicorn's
  10232. access log — carries it via TraceIDFilter, and is also written to
  10233. the ``X-Trace-Id`` response header so clients can pin a server-side
  10234. log search to the exact request they made.
  10235. """
  10236. from backend.app.core.trace import (
  10237. generate_trace_id,
  10238. normalise_inbound_trace_id,
  10239. trace_id_var,
  10240. )
  10241. inbound = normalise_inbound_trace_id(request.headers.get("X-Trace-Id"))
  10242. trace_id = inbound if inbound is not None else generate_trace_id()
  10243. token = trace_id_var.set(trace_id)
  10244. try:
  10245. response = await call_next(request)
  10246. finally:
  10247. # Reset the ContextVar so a record emitted in a totally
  10248. # unrelated background task that just happens to inherit this
  10249. # context doesn't keep referencing this request's ID forever.
  10250. # In practice ContextVar.reset is best-effort under asyncio
  10251. # task-spawn semantics, but the cost is one attribute write so
  10252. # we may as well do it.
  10253. trace_id_var.reset(token)
  10254. response.headers["X-Trace-Id"] = trace_id
  10255. return response
  10256. # API routes
  10257. app.include_router(auth.router, prefix=app_settings.api_prefix)
  10258. app.include_router(mfa.router, prefix=app_settings.api_prefix)
  10259. app.include_router(bug_report.router, prefix=app_settings.api_prefix)
  10260. app.include_router(users.router, prefix=app_settings.api_prefix)
  10261. app.include_router(groups.router, prefix=app_settings.api_prefix)
  10262. app.include_router(printers.router, prefix=app_settings.api_prefix)
  10263. app.include_router(printer_locations.router, prefix=app_settings.api_prefix)
  10264. app.include_router(archives.router, prefix=app_settings.api_prefix)
  10265. app.include_router(filaments.router, prefix=app_settings.api_prefix)
  10266. app.include_router(finance.router, prefix=app_settings.api_prefix)
  10267. app.include_router(inventory.router, prefix=app_settings.api_prefix)
  10268. app.include_router(labels.router, prefix=app_settings.api_prefix)
  10269. app.include_router(settings_routes.router, prefix=app_settings.api_prefix)
  10270. app.include_router(overlay_branding.router, prefix=app_settings.api_prefix)
  10271. app.include_router(cloud.router, prefix=app_settings.api_prefix)
  10272. app.include_router(orca_cloud.router, prefix=app_settings.api_prefix)
  10273. app.include_router(local_presets.router, prefix=app_settings.api_prefix)
  10274. app.include_router(smart_plugs.router, prefix=app_settings.api_prefix)
  10275. app.include_router(ha_sensors.router, prefix=app_settings.api_prefix)
  10276. app.include_router(location_ha_sensors.router, prefix=app_settings.api_prefix)
  10277. app.include_router(print_log.router, prefix=app_settings.api_prefix)
  10278. app.include_router(print_queue.router, prefix=app_settings.api_prefix)
  10279. app.include_router(scheduled_dryings.router, prefix=app_settings.api_prefix)
  10280. app.include_router(kprofiles.router, prefix=app_settings.api_prefix)
  10281. app.include_router(notifications.router, prefix=app_settings.api_prefix)
  10282. app.include_router(notification_templates.router, prefix=app_settings.api_prefix)
  10283. app.include_router(user_notifications.router, prefix=app_settings.api_prefix)
  10284. app.include_router(spoolman.router, prefix=app_settings.api_prefix)
  10285. app.include_router(spoolman_inventory.router, prefix=app_settings.api_prefix)
  10286. app.include_router(updates.router, prefix=app_settings.api_prefix)
  10287. app.include_router(sponsor_prompt.router, prefix=app_settings.api_prefix)
  10288. app.include_router(announcements.router, prefix=app_settings.api_prefix)
  10289. app.include_router(maintenance.router, prefix=app_settings.api_prefix)
  10290. app.include_router(camera.router, prefix=app_settings.api_prefix)
  10291. app.include_router(camwall.router, prefix=app_settings.api_prefix)
  10292. app.include_router(external_links.router, prefix=app_settings.api_prefix)
  10293. app.include_router(projects.router, prefix=app_settings.api_prefix)
  10294. app.include_router(library.router, prefix=app_settings.api_prefix)
  10295. app.include_router(library_tags.router, prefix=app_settings.api_prefix)
  10296. app.include_router(library_trash.router, prefix=app_settings.api_prefix)
  10297. app.include_router(library_variants.router, prefix=app_settings.api_prefix)
  10298. app.include_router(slice_jobs.router, prefix=app_settings.api_prefix)
  10299. app.include_router(slicer_pipelines.router, prefix=app_settings.api_prefix)
  10300. app.include_router(pipeline_runs.pipeline_run_create_router, prefix=app_settings.api_prefix)
  10301. app.include_router(pipeline_runs.pipeline_run_router, prefix=app_settings.api_prefix)
  10302. app.include_router(slicer_presets.router, prefix=app_settings.api_prefix)
  10303. app.include_router(archive_purge.router, prefix=app_settings.api_prefix)
  10304. app.include_router(makerworld.router, prefix=app_settings.api_prefix)
  10305. app.include_router(manyfold.router, prefix=app_settings.api_prefix)
  10306. app.include_router(api_keys.router, prefix=app_settings.api_prefix)
  10307. app.include_router(connected_apps.router, prefix=app_settings.api_prefix)
  10308. app.include_router(webhook.router, prefix=app_settings.api_prefix)
  10309. app.include_router(ams_history.router, prefix=app_settings.api_prefix)
  10310. app.include_router(printer_sensor_history.router, prefix=app_settings.api_prefix)
  10311. app.include_router(system.router, prefix=app_settings.api_prefix)
  10312. app.include_router(support.router, prefix=app_settings.api_prefix)
  10313. app.include_router(websocket.router, prefix=app_settings.api_prefix)
  10314. app.include_router(discovery.router, prefix=app_settings.api_prefix)
  10315. app.include_router(pending_uploads.router, prefix=app_settings.api_prefix)
  10316. app.include_router(firmware.router, prefix=app_settings.api_prefix)
  10317. app.include_router(github_backup.router, prefix=app_settings.api_prefix)
  10318. app.include_router(local_backup.router, prefix=app_settings.api_prefix)
  10319. app.include_router(obico.router, prefix=app_settings.api_prefix)
  10320. app.include_router(metrics.router, prefix=app_settings.api_prefix)
  10321. app.include_router(virtual_printers.router, prefix=app_settings.api_prefix)
  10322. app.include_router(spoolbuddy.router, prefix=app_settings.api_prefix)
  10323. # Serve static files (React build)
  10324. if app_settings.static_dir.exists() and any(app_settings.static_dir.iterdir()):
  10325. # Compressed, and cached for good where Vite hashed the name (#3175).
  10326. app.mount(
  10327. "/assets",
  10328. AssetStaticFiles(directory=app_settings.static_dir / "assets"),
  10329. name="assets",
  10330. )
  10331. if (app_settings.static_dir / "img").exists():
  10332. app.mount(
  10333. "/img",
  10334. StaticFiles(directory=app_settings.static_dir / "img"),
  10335. name="img",
  10336. )
  10337. if (app_settings.static_dir / "icons").exists():
  10338. app.mount(
  10339. "/icons",
  10340. StaticFiles(directory=app_settings.static_dir / "icons"),
  10341. name="icons",
  10342. )
  10343. # Self-hosted Inter woff2 files (#1460). Without this mount /fonts/*.woff2
  10344. # falls through to the SPA catch-all and returns index.html, which the
  10345. # browser's font sanitizer rejects ("downloadable font: rejected by
  10346. # sanitizer").
  10347. if (app_settings.static_dir / "fonts").exists():
  10348. app.mount(
  10349. "/fonts",
  10350. StaticFiles(directory=app_settings.static_dir / "fonts"),
  10351. name="fonts",
  10352. )
  10353. @app.get("/")
  10354. async def serve_frontend():
  10355. """Serve the React frontend."""
  10356. index_file = app_settings.static_dir / "index.html"
  10357. if index_file.exists():
  10358. return FileResponse(index_file, headers=_HTML_CACHE_HEADERS)
  10359. return {
  10360. "message": "Bambuddy API",
  10361. "docs": "/docs",
  10362. "frontend": "Build and place React app in /static directory",
  10363. }
  10364. # index.html must always be revalidated — Vite emits content-hashed JS/CSS
  10365. # bundles (e.g. `index-JRaF_JhW.js`), so the JS itself is safe to cache
  10366. # forever, but the HTML wrapping it is the only file that knows which hash
  10367. # is current. Without explicit cache-control headers Chromium decides
  10368. # heuristically (typically 10% of the time since Last-Modified) and on
  10369. # long-running kiosks happily serves stale HTML across browser restarts.
  10370. # That stale HTML references an old bundle hash, the old bundle is also
  10371. # in the disk cache, and the user ends up running pre-update JS forever
  10372. # without ever knowing why. ``no-cache`` (revalidate every time, but a
  10373. # 304 is cheap) is the correct setting for an SPA's entry HTML.
  10374. _HTML_CACHE_HEADERS = {"Cache-Control": "no-cache, must-revalidate"}
  10375. @app.get("/health")
  10376. async def health_check():
  10377. """Health check endpoint."""
  10378. return {"status": "healthy"}
  10379. # GET + HEAD on the three PWA bootstrap routes (#1460). Scanners and a plain
  10380. # `curl -I` use HEAD; FastAPI's @app.get only registers GET, so HEAD answers
  10381. # with 405 Method Not Allowed and shows up as a "broken manifest" red herring
  10382. # in deployment debugging.
  10383. @app.api_route("/manifest.json", methods=["GET", "HEAD"])
  10384. async def serve_manifest():
  10385. """Serve PWA manifest."""
  10386. manifest_file = app_settings.static_dir / "manifest.json"
  10387. if manifest_file.exists():
  10388. return FileResponse(manifest_file, media_type="application/manifest+json")
  10389. return {"error": "Manifest not found"}
  10390. @app.api_route("/sw.js", methods=["GET", "HEAD"])
  10391. async def serve_service_worker():
  10392. """Serve service worker."""
  10393. sw_file = app_settings.static_dir / "sw.js"
  10394. if sw_file.exists():
  10395. return FileResponse(
  10396. sw_file,
  10397. media_type="application/javascript",
  10398. headers={"Cache-Control": "no-cache, no-store, must-revalidate"},
  10399. )
  10400. return {"error": "Service worker not found"}
  10401. @app.api_route("/sw-register.js", methods=["GET", "HEAD"])
  10402. async def serve_sw_register():
  10403. """Serve the service-worker registration bootstrap script.
  10404. Served as a real JS file so the strict `script-src 'self'` CSP covers it
  10405. without needing 'unsafe-inline' or per-build hashes on the inline tag.
  10406. """
  10407. reg_file = app_settings.static_dir / "sw-register.js"
  10408. if reg_file.exists():
  10409. return FileResponse(reg_file, media_type="application/javascript")
  10410. return {"error": "sw-register.js not found"}
  10411. # ── GCode viewer static files ────────────────────────────────────────────────
  10412. # Catch-all route for React Router (must be last)
  10413. @app.get("/{full_path:path}")
  10414. async def serve_spa(full_path: str):
  10415. """Serve React app for client-side routing."""
  10416. # Don't intercept API routes - raise proper 404 so FastAPI can handle redirects
  10417. if full_path.startswith("api/"):
  10418. from fastapi import HTTPException
  10419. raise HTTPException(status_code=404, detail="Not found")
  10420. index_file = app_settings.static_dir / "index.html"
  10421. if index_file.exists():
  10422. return FileResponse(index_file, headers=_HTML_CACHE_HEADERS)
  10423. return {"error": "Frontend not built"}