| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886 |
- import asyncio
- import json
- import logging
- import math
- import os
- import posixpath
- import secrets
- import time
- from contextlib import asynccontextmanager
- from datetime import datetime, timedelta, timezone
- from logging.handlers import RotatingFileHandler
- from pathlib import Path, PurePosixPath
- from urllib.parse import urlparse
- from fastapi import FastAPI
- from fastapi.responses import FileResponse
- from fastapi.staticfiles import StaticFiles
- from sqlalchemy import delete, or_, select, text
- from backend.app.api.routes import (
- ams_history,
- api_keys,
- archive_purge,
- archives,
- auth,
- bug_report,
- camera,
- camwall,
- cloud,
- discovery,
- external_links,
- filaments,
- finance,
- firmware,
- github_backup,
- groups,
- ha_sensors,
- inventory,
- kprofiles,
- labels,
- library,
- library_tags,
- library_trash,
- library_variants,
- local_backup,
- local_presets,
- location_ha_sensors,
- maintenance,
- makerworld,
- metrics,
- mfa,
- notification_templates,
- notifications,
- obico,
- orca_cloud,
- pending_uploads,
- pipeline_runs,
- print_log,
- print_queue,
- printer_sensor_history,
- printers,
- projects,
- scheduled_dryings,
- settings as settings_routes,
- slice_jobs,
- slicer_pipelines,
- slicer_presets,
- smart_plugs,
- sponsor_prompt,
- spoolbuddy,
- spoolman,
- spoolman_inventory,
- support,
- system,
- updates,
- user_notifications,
- users,
- virtual_printers,
- webhook,
- websocket,
- )
- from backend.app.api.routes.maintenance import _get_printer_maintenance_internal, ensure_default_types
- from backend.app.api.routes.support import init_debug_logging
- from backend.app.core.config import APP_VERSION, settings as app_settings
- from backend.app.core.database import async_session, engine, init_db
- from backend.app.core.tasks import spawn_background_task
- from backend.app.core.websocket import ws_manager
- from backend.app.services import print_dispatch_context
- from backend.app.services.archive import ArchiveService, peek_plate_index_in_3mf, swap_plate_suffix
- from backend.app.services.archive_purge import archive_purge_service
- from backend.app.services.bambu_ftp import (
- FileNotOnPrinterError,
- cache_3mf_download,
- clear_3mf_cache,
- download_file_async,
- download_file_try_paths_async,
- ftps_handshake_blocked,
- get_cached_3mf,
- get_ftp_retry_settings,
- normalize_3mf_name,
- with_ftp_retry,
- )
- from backend.app.services.bambu_mqtt import PrinterState
- from backend.app.services.energy_plug import energy_plug_candidates, select_energy_reading
- from backend.app.services.github_backup import github_backup_service
- from backend.app.services.ha_sensor_manager import ha_sensor_manager
- from backend.app.services.homeassistant import homeassistant_service
- from backend.app.services.library_trash import library_trash_service
- from backend.app.services.local_backup import local_backup_service
- from backend.app.services.location_ha_sensor_manager import location_ha_sensor_manager
- from backend.app.services.mqtt_relay import mqtt_relay
- from backend.app.services.mqtt_smart_plug import mqtt_smart_plug_service
- from backend.app.services.notification_service import notification_service
- from backend.app.services.obico_detection import obico_detection_service
- from backend.app.services.print_cost_estimate import plate_scoped_run_estimate as _plate_scoped_run_estimate
- from backend.app.services.print_scheduler import scheduler as print_scheduler
- from backend.app.services.print_storage import (
- REASON_FTPS_COOLOFF,
- external_storage_present,
- ftp_probe_paths,
- print_file_reachable_over_ftp,
- )
- from backend.app.services.printer_manager import (
- init_printer_connections,
- parse_plate_id,
- printer_manager,
- printer_state_to_dict,
- resolve_plate_id,
- )
- from backend.app.services.slot_kprofile import find_slot_kprofile_for_extruder
- from backend.app.services.slot_nozzle import (
- nozzle_diameter_for_extruder,
- nozzle_flow_for_extruder,
- resolve_slot_nozzle,
- )
- from backend.app.services.smart_plug_manager import smart_plug_manager
- from backend.app.services.spool_assignment_notifications import (
- notify_missing_spool_assignments_on_print_start,
- )
- from backend.app.services.spool_filament_preset import printer_safe_filament_id
- from backend.app.services.spoolman import close_spoolman_client, get_spoolman_client, init_spoolman_client
- from backend.app.services.spoolman_tracking import (
- cleanup_tracking as _cleanup_spoolman_tracking,
- report_usage as _report_spoolman_usage,
- store_print_data as _store_spoolman_print_data,
- )
- from backend.app.services.tasmota import tasmota_service
- from backend.app.utils.ams_drying import is_drying_active, temperature_alarm_suppressed
- from backend.app.utils.filament_types import printer_filament_type
- from backend.app.utils.fts_routing import extruder_for_inlet
- from backend.app.utils.local_time import utcnow_naive
- from backend.app.utils.print_jobs import is_internal_printer_job
- # =============================================================================
- # Dependency Check - runs before other imports to give helpful error messages
- # =============================================================================
- def _start_error_server(missing_packages: list):
- """Start a minimal HTTP server to display dependency errors in browser."""
- import os
- import signal
- from http.server import BaseHTTPRequestHandler, HTTPServer
- packages_html = "".join(f"<li><code>{p}</code></li>" for p in missing_packages)
- html = f"""<!DOCTYPE html>
- <html>
- <head>
- <title>Bambuddy - Setup Required</title>
- <style>
- body {{
- font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
- background: #0f172a; color: #e2e8f0;
- display: flex; justify-content: center; align-items: center;
- min-height: 100vh; margin: 0; padding: 20px; box-sizing: border-box;
- }}
- .container {{
- background: #1e293b; border-radius: 12px; padding: 40px;
- max-width: 600px; text-align: center; box-shadow: 0 4px 20px rgba(0,0,0,0.3);
- }}
- h1 {{ color: #f87171; margin-bottom: 10px; }}
- h2 {{ color: #94a3b8; font-weight: normal; margin-top: 0; }}
- .packages {{
- background: #0f172a; border-radius: 8px; padding: 20px;
- margin: 20px 0; text-align: left;
- }}
- .packages ul {{ margin: 0; padding-left: 20px; }}
- .packages li {{ color: #fbbf24; margin: 8px 0; }}
- .command {{
- background: #0f172a; border-radius: 8px; padding: 15px 20px;
- margin: 15px 0; font-family: monospace; color: #4ade80;
- text-align: left; overflow-x: auto;
- }}
- .note {{ color: #94a3b8; font-size: 14px; margin-top: 20px; }}
- </style>
- </head>
- <body>
- <div class="container">
- <h1>Setup Required</h1>
- <h2>Missing Python packages</h2>
- <div class="packages"><ul>{packages_html}</ul></div>
- <p>To fix, run this command on your server:</p>
- <div class="command">pip install -r requirements.txt</div>
- <p>Or if using a virtual environment:</p>
- <div class="command">./venv/bin/pip install -r requirements.txt</div>
- <p class="note">After installing, restart Bambuddy:<br>
- <code>sudo systemctl restart bambuddy</code></p>
- </div>
- </body>
- </html>"""
- class ErrorHandler(BaseHTTPRequestHandler):
- def do_GET(self):
- self.send_response(503)
- self.send_header("Content-type", "text/html")
- self.end_headers()
- self.wfile.write(html.encode())
- def log_message(self, format, *args):
- print(f"[Error Server] {args[0]}")
- port = int(os.environ.get("PORT", 8000))
- print(f"\nStarting error server on http://0.0.0.0:{port}")
- print("Visit this URL in your browser to see the error details.\n")
- server = HTTPServer(("0.0.0.0", port), ErrorHandler) # nosec B104
- def shutdown(signum, frame):
- print("\nShutting down error server...")
- raise SystemExit(0)
- signal.signal(signal.SIGTERM, shutdown)
- signal.signal(signal.SIGINT, shutdown)
- server.serve_forever()
- def check_dependencies():
- """Check that all required packages are installed."""
- missing = []
- # Map of import name -> package name (for pip install)
- required = {
- "jwt": "PyJWT",
- "fastapi": "fastapi",
- "uvicorn": "uvicorn",
- "sqlalchemy": "sqlalchemy",
- "aiosqlite": "aiosqlite",
- "pydantic": "pydantic",
- "paho.mqtt": "paho-mqtt",
- }
- for module, package in required.items():
- try:
- __import__(module)
- except ImportError:
- missing.append(package)
- if missing:
- print("\n" + "=" * 60)
- print("ERROR: Missing required Python packages!")
- print("=" * 60)
- print(f"\nMissing packages: {', '.join(missing)}")
- print("\nTo fix, run:")
- print(" pip install -r requirements.txt")
- print("\nOr if using a virtual environment:")
- print(" ./venv/bin/pip install -r requirements.txt")
- print("=" * 60 + "\n")
- _start_error_server(missing)
- check_dependencies()
- # =============================================================================
- # Import settings first for logging configuration
- # Configure logging based on settings
- # DEBUG=true -> DEBUG level, else use LOG_LEVEL setting
- log_level_str = "DEBUG" if app_settings.debug else app_settings.log_level.upper()
- log_level = getattr(logging, log_level_str, logging.INFO)
- # Trace ID column ([-] when no request scope is active — startup, MQTT
- # callbacks, scheduled tasks not chained from a request — so the column
- # stays visually aligned and missing values are obvious in grep). See
- # backend/app/core/trace.py for the ContextVar that feeds this slot.
- log_format = "%(asctime)s %(levelname)s [%(name)s] [%(trace_id)s] %(message)s"
- # Create root logger
- root_logger = logging.getLogger()
- root_logger.setLevel(log_level)
- # Trace-ID injection: this filter populates record.trace_id from the
- # per-request ContextVar so the format string above can reference it.
- # Attached to each HANDLER (not the root logger) because Python's
- # logging semantics only invoke a logger's filters on records that
- # *originated* at that logger — records propagated up from child
- # loggers (every named logger in the app) never trigger root's filter.
- # Putting it on the handlers means every record any handler emits gets
- # trace_id injected just before the formatter runs, regardless of which
- # logger created the record. Without this, the formatter raises
- # KeyError on every child-logger record and the record is silently
- # dropped — which is exactly the "logs/bambuddy.log only shows logs
- # partially" bug we hit. See backend/app/core/trace.py for the
- # ContextVar the filter reads.
- from backend.app.core.trace import TraceIDFilter
- _trace_id_filter = TraceIDFilter()
- # Console handler - always enabled
- console_handler = logging.StreamHandler()
- console_handler.setLevel(log_level)
- console_handler.setFormatter(logging.Formatter(log_format))
- console_handler.addFilter(_trace_id_filter)
- root_logger.addHandler(console_handler)
- # File handler - only in production or if explicitly enabled
- if app_settings.log_to_file:
- log_file = app_settings.log_dir / "bambuddy.log"
- file_handler = RotatingFileHandler(
- log_file,
- maxBytes=app_settings.log_max_bytes,
- backupCount=app_settings.log_backup_count,
- encoding="utf-8",
- )
- file_handler.setLevel(log_level)
- file_handler.setFormatter(logging.Formatter(log_format))
- file_handler.addFilter(_trace_id_filter)
- root_logger.addHandler(file_handler)
- logging.info("Logging to file: %s", log_file)
- # Pipe uvicorn's HTTP access log to bambuddy.log too. Uvicorn ships its
- # access logger with propagate=False by default, so without this attach
- # there is no on-disk record of which endpoint triggered a server-state
- # change — the rogue stop_print mystery on 2026-04-26 was untraceable
- # for exactly this reason. Filtered to write methods only
- # (POST/PUT/PATCH/DELETE) so the high-volume status-poll GETs from the
- # frontend don't churn the rotation window faster than it's useful.
- from backend.app.core.logging_filters import (
- CancelledPoolNoiseFilter,
- WriteRequestsOnlyFilter,
- )
- uvicorn_access_logger = logging.getLogger("uvicorn.access")
- uvicorn_access_logger.addHandler(file_handler)
- uvicorn_access_logger.addFilter(WriteRequestsOnlyFilter())
- # Uvicorn's access logger has propagate=False (its own default), so the
- # root-attached TraceIDFilter never sees these records. Attach a
- # second instance directly so HTTP access lines carry the same trace
- # ID column as the application logs they correlate with.
- uvicorn_access_logger.addFilter(TraceIDFilter())
- # Drop SQLAlchemy connection-pool log noise that's caused by Starlette's
- # BaseHTTPMiddleware cancelling the inner task scope on client
- # disconnect (#1112). The cancel-safe `get_db` already prevents the
- # underlying transaction leak; this filter only suppresses the residual
- # log records that pre-existing pools still emit during their cleanup.
- logging.getLogger("sqlalchemy.pool").addFilter(CancelledPoolNoiseFilter())
- # Reduce noise from third-party libraries in production
- if not app_settings.debug:
- logging.getLogger("sqlalchemy.engine").setLevel(logging.WARNING)
- logging.getLogger("httpcore").setLevel(logging.WARNING)
- logging.getLogger("httpx").setLevel(logging.WARNING)
- logging.getLogger("paho.mqtt").setLevel(logging.WARNING)
- logging.info("Bambuddy starting - debug=%s, log_level=%s", app_settings.debug, log_level_str)
- # Track active prints: {(printer_id, filename): archive_id}
- _active_prints: dict[tuple[int, str], int] = {}
- # #1721: stage-22 pre-captured finish photo bytes per printer. on_finish_photo_moment
- # fires when stg_cur enters 22 ("Filament unloading") at end-of-print — toolhead
- # parked, bed not yet dropped — and grabs a single camera frame into this cache.
- # `_background_finish_photo` (inside on_print_complete) consumes the cached bytes
- # instead of running its own grab-now chain when present, so the finish photo
- # captures the better-framed pre-bed-drop moment without us having to force
- # timelapse on at dispatch (the #1397 mechanism that caused #1721's per-layer
- # nozzle parking on slicer profiles with Timelapse Type = Smooth).
- #
- # #2708: the bytes in here are ALWAYS already rotated by the printer's
- # camera_rotation. `on_finish_photo_moment` owns that, because one of its
- # sources (the #1867 in-print bank) is rotated before it ever reaches the
- # bank and the others are not — so the consumer can't tell them apart and
- # must not rotate again.
- _stage22_finish_frames: dict[int, bytes] = {}
- # #1790: per-printer producer-done event. Set by `on_finish_photo_moment` in its
- # `finally` block (whether it captured a frame or not). The consumer in
- # `_background_finish_photo` waits on it before reading `_stage22_finish_frames`
- # so the FINISH-state fallback path — where moment and completion are dispatched
- # back-to-back — doesn't race past the producer with an empty pop, and the
- # consumer's RTSP fallback can't collide with the producer's still-in-flight RTSP
- # grab (Bambu printers allow only one RTSP client at a time).
- _stage22_finish_in_flight: dict[int, asyncio.Event] = {}
- # #1867: rolling "last in-print camera frame" per printer. Refreshed on
- # layer-change and on print-progress advances (#2547) while the model is still
- # printing, then consumed by the FINISH-state finish-photo path when the
- # dispatcher recorded that it injected End G-code into this print. Bambu
- # reports gcode_state=FINISH AFTER the user End G-code (e.g. SwapMod
- # plate-swap) has run, so a live grab there would capture the swapped/empty
- # plate.
- #
- # The load-bearing property: both drivers are print telemetry that stops before
- # the End G-code executes — no further layer_num increases, and mc_percent
- # freezes — so the last banked frame is always the finished print before the
- # swap. Anything added as a third driver must hold that same property.
- _inprint_frame_bank: dict[int, bytes] = {}
- # Monotonic timestamp of the last banked frame per printer — throttles banking
- # so tall prints don't add a camera grab on every layer.
- _inprint_frame_bank_ts: dict[int, float] = {}
- # Minimum seconds between banked frames, except the final object layer which
- # always refreshes for the best framing.
- _INPRINT_BANK_MIN_INTERVAL = 25.0
- # Per-printer "connected" edge tracker. Used by `on_printer_status_change`
- # to fire `reconcile_stale_active_prints` exactly once per (re)connection
- # (#1542 follow-up — power-cycle ghost prints). The value is True after
- # the first connected status update for that connection; transitions back
- # to False whenever we observe `state.connected = False` so the next
- # reconnect re-arms reconciliation. Keyed by printer_id.
- _printer_reconciled_since_connect: dict[int, bool] = {}
- # Same edge, same keying, for priming the printer's calibration table exactly
- # once per (re)connection. Nothing else asks for it on connect: state.kprofiles
- # is otherwise filled only when someone opens the Profiles page or Configure
- # Slot, when a GitHub backup runs, or when the printer happens to answer
- # somebody else's query on the report topic. Until then the AMS slot card has
- # no K value to show on the printers whose trays carry none of their own
- # (#2854 — H2-series report cali_idx and nothing more).
- _printer_kprofiles_primed_since_connect: dict[int, bool] = {}
- # Track expected prints from reprint/scheduled (skip auto-archiving for these)
- # {(printer_id, filename): archive_id}
- _expected_prints: dict[tuple[int, str], int] = {}
- # Track AMS mapping for prints: {archive_id: [global_tray_id_per_slot]}
- # Used by usage tracker to map 3MF slots to physical AMS trays
- _print_ams_mappings: dict[int, list[int]] = {}
- # Track cost center selection for the current print run: {archive_id: cost_center_id}
- _print_cost_center_ids: dict[int, int] = {}
- # Track plate_id for prints from multi-plate 3MFs: {archive_id: plate_id}
- # Used by usage tracker to scope 3MF parsing to the dispatched plate (#1697).
- # Populated by direct-Print and queue dispatch paths; queue prints also have a
- # redundant queue-item lookup in on_print_start so this dict isn't load-bearing
- # for the queue path. Cleared on print completion or TTL eviction.
- _print_plate_ids: dict[int, int] = {}
- # Track progress milestones for notifications: {printer_id: last_milestone_notified}
- # Milestones are 25, 50, 75. Value of 0 means no milestone notified yet for current print.
- _last_progress_milestone: dict[int, int] = {}
- # Track whether first layer complete notification has been sent for current print
- _first_layer_notified: dict[int, bool] = {}
- # Track whether we already sent a kill-switch stop for the current unauthorized print
- _unauthorized_print_kill_sent: set[int] = set()
- # The MQTT status callback is a hot path. Cache the two-setting kill-switch
- # lookup briefly so an unknown active print does not query the database on
- # every status frame. A short TTL keeps settings changes responsive.
- _KILL_SWITCH_SETTING_CACHE_TTL_SECONDS = 5.0
- _kill_switch_setting_cache: tuple[bool, float] | None = None
- # Provider notification started when the kill switch stops a print. The later
- # MQTT print-complete callback awaits this task and only sends its regular
- # provider notification when the immediate attempt failed.
- _kill_switch_notification_tasks: dict[int, asyncio.Task[bool]] = {}
- # Track HMS errors that have been notified: {printer_id: set of error codes}
- # This prevents sending duplicate notifications for the same error
- _notified_hms_errors: dict[int, set[str]] = {}
- # Track when HMS errors were last seen: {printer_id: timestamp}
- # Used to debounce clearing — prevents flapping errors from re-triggering notifications
- _hms_last_seen: dict[int, float] = {}
- _HMS_CLEAR_GRACE_SECONDS = 30.0
- # Track timelapse file baselines at print start: {printer_id: set of video filenames}
- # Used for snapshot-diff detection at print completion
- _timelapse_baselines: dict[int, set[str]] = {}
- # Track printers waiting for bed to cool after print completion.
- # Event-driven: fires when bed_temper arrives via MQTT below threshold.
- # {printer_id: {"threshold": float, "filename": str, "registered_at": float}}
- _bed_cool_waiters: dict[int, dict] = {}
- # Track printers where the user explicitly stopped the print from the queue UI.
- # When on_print_complete fires with status "failed" for these printers we treat it
- # as "cancelled" (stopped by user) so the correct notification email is sent.
- _user_stopped_printers: set[int] = set()
- # Offline-notification edge state (#1752): fire `on_printer_offline` exactly
- # once when a printer transitions connected → disconnected. `_printer_last_connected`
- # holds the previous observation so we only fire on the True → False edge (a
- # False → False repeat doesn't notify; an initial False at startup doesn't
- # notify either, since there's no prior True). `_printer_offline_notify_tasks`
- # holds the per-printer pending asyncio task that fires the notification
- # after a debounce window — cancelled if the printer reconnects before the
- # window elapses, so transient MQTT blips don't flood the user.
- _printer_last_connected: dict[int, bool] = {}
- _printer_offline_notify_tasks: dict[int, asyncio.Task] = {}
- # Debounce: a printer must stay offline this long before we notify. Sized
- # against the staleness path (`bambu_mqtt.py::STALE_RECONNECT_COOLDOWN = 30s`)
- # so a single stale-trigger cooldown isn't enough to fire — only a real
- # offline that survives one reconnect attempt notifies.
- _PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS = 60.0
- # HMS short-code → human-readable failure reason. Used by _dispatch_archive_update
- # when status="failed" to label the print's failure_reason in archives.
- #
- # Earlier code matched on `module` alone (e.g. "any module 0x0C HMS → Layer shift"),
- # which is wrong on two counts:
- # 1. Real layer-shift codes live in module 0x03 (see Bambu wiki), not 0x0C.
- # 2. Module 0x0C is "Motion Controller" — broad category that also covers cameras
- # and visual markers, AND the H2D firmware emits a 0x0C HMS (0C00_001B, not in
- # the public wiki) as part of its user-cancel sequence. Matching on the module
- # alone caused user-cancellations to be archived as "Layer shift" failures.
- # We now match by full short code only — anything not in this map leaves
- # failure_reason=None rather than guessing.
- # Values are the canonical camelCase failure-reason keys, NOT display labels
- # (issue #2974). The vocabulary is enforced on writes by
- # ``_FAILURE_REASON_KEYS`` in ``api/routes/print_log.py`` and rendered through
- # ``t('editArchive.failureReasons.<key>')`` on both the archive editor and the
- # Statistics breakdown. Storing a label here instead put a second spelling of
- # the same cause into one column: the Failure Analysis widget groups on the raw
- # value, so a print the backend classified and an identical one a user
- # classified counted as two different reasons, and the label form could never
- # be translated because there was no key for ``t()`` to resolve.
- _HMS_FAILURE_REASONS: dict[str, str] = {
- # Layer shift / step loss
- "0300_4057": "layerShift",
- "0300_4068": "layerShift",
- "0300_800C": "layerShift",
- # Filament runout (printer-side & per-AMS-slot)
- "0300_8004": "filamentRunout",
- "0700_8011": "filamentRunout",
- "0701_8011": "filamentRunout",
- "0702_8011": "filamentRunout",
- "0703_8011": "filamentRunout",
- "0704_8011": "filamentRunout",
- "0705_8011": "filamentRunout",
- "0706_8011": "filamentRunout",
- "0707_8011": "filamentRunout",
- "07FF_8011": "filamentRunout",
- # Clogged nozzle / extruder
- "0300_4006": "cloggedNozzle",
- "0300_8016": "cloggedNozzle",
- "0300_801C": "cloggedNozzle",
- "0700_8003": "cloggedNozzle",
- "0700_8007": "cloggedNozzle",
- "0700_8013": "cloggedNozzle",
- "0701_8003": "cloggedNozzle",
- "0701_8007": "cloggedNozzle",
- "0701_8013": "cloggedNozzle",
- "0702_8003": "cloggedNozzle",
- }
- def _hms_short_code(attr: int, code: int | str) -> str:
- """Build the canonical "MMMM_CCCC" HMS short code from raw attr/code values."""
- if isinstance(code, str):
- code_int = int(code.replace("0x", ""), 16) if code else 0
- else:
- code_int = int(code or 0)
- attr_int = int(attr or 0)
- return f"{(attr_int >> 16) & 0xFFFF:04X}_{code_int & 0xFFFF:04X}"
- def derive_failure_reason(status: str, hms_errors: list[dict] | None) -> str | None:
- """Derive a human-readable failure_reason for an archived print.
- Returns "User cancelled" for cancelled/aborted prints; for failed prints,
- returns the first matching reason from _HMS_FAILURE_REASONS, or None when
- no HMS code matches (don't guess — null is honest).
- """
- if status in ("aborted", "cancelled"):
- return "userCancelled"
- if status != "failed":
- return None
- for err in hms_errors or []:
- short_code = _hms_short_code(err.get("attr", 0), err.get("code", 0))
- if short_code in _HMS_FAILURE_REASONS:
- return _HMS_FAILURE_REASONS[short_code]
- return None
- # Track created_by_id for expected prints so the user email can be sent even when
- # the archive itself doesn't have created_by_id set (e.g. library-file-based prints).
- # {(printer_id, filename): created_by_id}
- _expected_print_creators: dict[tuple[int, str], int] = {}
- # Per-printer lock that serialises the spool-assignment side of on_ams_change
- # (auto-unlink stale + auto-assign new) when MQTT bursts deliver multiple AMS
- # updates for the same printer in quick succession (~30 ms apart, observed in
- # the wild on H2D + dual AMS).
- #
- # Without this serialisation, two concurrent on_ams_change callbacks each read
- # "no assignment for (printer, ams, tray)", each call auto_assign_spool, and
- # the second commit hits
- # IntegrityError: duplicate key value violates unique constraint
- # "spool_assignment_printer_id_ams_id_tray_id_key"
- # SQLite's WAL serial-write semantics had been silently swallowing the race
- # until optional Postgres support landed (asyncpg allows true concurrent
- # transactions and surfaces the constraint violation).
- #
- # Scope is intentionally narrow: only the two DB-mutating blocks (unlink +
- # assign) are inside the lock. The Spoolman sync block further down stays
- # concurrent because it's network-bound and idempotent.
- _ams_assignment_locks: dict[int, asyncio.Lock] = {}
- def _get_ams_assignment_lock(printer_id: int) -> asyncio.Lock:
- """Return the per-printer assignment lock, creating it on first use."""
- lock = _ams_assignment_locks.get(printer_id)
- if lock is None:
- lock = asyncio.Lock()
- _ams_assignment_locks[printer_id] = lock
- return lock
- # Per-printer dedup for unknown_tag WS broadcasts. Keyed by
- # (ams_id, tray_id) -> (tag_uid, tray_uuid); we only re-broadcast when the
- # tag tuple changes for the slot. Cleared when the slot is reported empty
- # so remove + reinsert reliably re-prompts the UI.
- _unknown_tag_last_broadcast: dict[int, dict[tuple[int, int], tuple[str, str]]] = {}
- async def _broadcast_unknown_tag(
- *,
- printer_id: int,
- ams_id: int,
- tray_id: int,
- tag_uid: str,
- tray_uuid: str,
- tray_type: str | None = None,
- tray_color: str | None = None,
- tray_sub_brands: str | None = None,
- tray_count: int | None = None,
- ) -> None:
- """Broadcast unknown_tag, deduped so repeated MQTT pushes for the same slot+tag don't spam the UI."""
- _logger = logging.getLogger(__name__)
- slot_key = (ams_id, tray_id)
- tag_key = (tag_uid or "", tray_uuid or "")
- per_printer = _unknown_tag_last_broadcast.setdefault(printer_id, {})
- if per_printer.get(slot_key) == tag_key:
- _logger.debug(
- "unknown_tag deduped for printer=%d AMS=%d slot=%d tag=%s",
- printer_id,
- ams_id,
- tray_id,
- tag_key[0][:8] or tag_key[1][:8] or "(none)",
- )
- return
- _logger.info(
- "unknown_tag broadcast: printer=%d AMS=%d slot=%d type=%r color=%r tag=%s",
- printer_id,
- ams_id,
- tray_id,
- tray_type,
- tray_color,
- tag_key[0][:8] or tag_key[1][:8] or "(none)",
- )
- # Broadcast first; only commit the dedup if the WS write succeeds.
- # If broadcast raises, the next MQTT push retries instead of being
- # permanently silenced by a poisoned dedup entry.
- await ws_manager.broadcast(
- {
- "type": "unknown_tag",
- "printer_id": printer_id,
- "ams_id": ams_id,
- "tray_id": tray_id,
- "tag_uid": tag_uid,
- "tray_uuid": tray_uuid,
- "tray_type": tray_type,
- "tray_color": tray_color,
- "tray_sub_brands": tray_sub_brands,
- "tray_count": tray_count,
- }
- )
- per_printer[slot_key] = tag_key
- def _clear_unknown_tag_dedup(printer_id: int, ams_id: int, tray_id: int) -> None:
- """Drop the cached last-broadcast tag for a slot (called when slot reports empty or gets matched)."""
- per_printer = _unknown_tag_last_broadcast.get(printer_id)
- if per_printer is None:
- return
- per_printer.pop((ams_id, tray_id), None)
- # TTL for expected-print entries: evict registrations older than this to prevent
- # unbounded growth when a print is registered but never starts (e.g. printer
- # disconnect, app restart, print started from the printer panel).
- _EXPECTED_PRINT_TTL_SECONDS: int = 2 * 60 * 60 # 2 hours
- # Registration timestamps used for TTL eviction: {(printer_id, filename): monotonic_time}
- _expected_print_registered_at: dict[tuple[int, str], float] = {}
- # Cleanup loop interval
- _EXPECTED_PRINT_CLEANUP_INTERVAL: int = 15 * 60 # 15 minutes
- _expected_prints_cleanup_task: asyncio.Task | None = None
- _ACTIVE_PRINT_STATES: set[str] = {"RUNNING", "PRINTING", "PAUSE"}
- def _build_status_print_keys(printer_id: int, state: PrinterState) -> list[tuple[int, str]]:
- """Build filename keys for matching a printer status update to Bambuddy-owned jobs."""
- possible_keys: list[tuple[int, str]] = []
- filename = (state.gcode_file or state.current_print or "").strip()
- subtask_name = (state.subtask_name or "").strip()
- if subtask_name:
- possible_keys.append((printer_id, subtask_name))
- possible_keys.append((printer_id, f"{subtask_name}.3mf"))
- possible_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
- if filename:
- base_name = filename.rsplit("/", 1)[-1]
- if base_name.endswith(".gcode.3mf"):
- root_name = base_name[: -len(".gcode.3mf")]
- possible_keys.append((printer_id, root_name))
- possible_keys.append((printer_id, base_name))
- possible_keys.append((printer_id, f"{root_name}.gcode"))
- possible_keys.append((printer_id, f"{root_name}.3mf"))
- elif base_name.endswith(".3mf"):
- root_name = base_name[: -len(".3mf")]
- possible_keys.append((printer_id, root_name))
- possible_keys.append((printer_id, base_name))
- elif base_name.endswith(".gcode"):
- root_name = base_name[: -len(".gcode")]
- possible_keys.append((printer_id, root_name))
- possible_keys.append((printer_id, f"{root_name}.3mf"))
- possible_keys.append((printer_id, base_name))
- else:
- possible_keys.append((printer_id, base_name))
- possible_keys.append((printer_id, f"{base_name}.3mf"))
- return possible_keys
- def _is_bambuddy_authorized_print_in_memory(printer_id: int, state: PrinterState) -> bool:
- """Check the cheap, process-local print ownership signals."""
- if printer_manager.get_current_print_user(printer_id):
- return True
- return any(key in _expected_prints or key in _active_prints for key in _build_status_print_keys(printer_id, state))
- async def _is_printer_kill_switch_enabled_cached() -> bool:
- """Return the kill-switch setting without querying on every MQTT frame."""
- global _kill_switch_setting_cache
- now = time.monotonic()
- if _kill_switch_setting_cache is not None:
- enabled, expires_at = _kill_switch_setting_cache
- if now < expires_at:
- return enabled
- async with async_session() as db:
- from backend.app.services.finance_budget import is_printer_kill_switch_enabled
- enabled = await is_printer_kill_switch_enabled(db)
- _kill_switch_setting_cache = (enabled, now + _KILL_SWITCH_SETTING_CACHE_TTL_SECONDS)
- return enabled
- async def _is_bambuddy_authorized_print(printer_id: int, state: PrinterState, db) -> bool | None:
- """Resolve whether the current print was started by Bambuddy.
- ``None`` means identity is not yet safe to decide. The kill switch must
- defer in that case: stopping a print is irreversible, and the first status
- frames after a restart may arrive before all subtask fields are populated.
- """
- if _is_bambuddy_authorized_print_in_memory(printer_id, state):
- return True
- possible_keys = _build_status_print_keys(printer_id, state)
- # In-memory ownership is lost on every Bambuddy restart, so fall back to what
- # is on disk. subtask_id is minted per print and pins the answer to the job
- # actually running, rather than to an unrelated one that reuses a filename.
- raw_subtask_id = getattr(state, "subtask_id", None)
- subtask_id = str(raw_subtask_id).strip() if raw_subtask_id is not None else ""
- if subtask_id in ("", "0"):
- return None
- from backend.app.models.archive import PrintArchive
- result = await db.execute(
- select(PrintArchive)
- .where(
- PrintArchive.printer_id == printer_id,
- PrintArchive.status == "printing",
- PrintArchive.subtask_id == subtask_id,
- )
- .order_by(PrintArchive.created_at.desc())
- .limit(1)
- )
- archive = result.scalar_one_or_none()
- # An archive row on its own proves nothing: `on_print_start` archives every
- # print it observes, including ones started from Bambu Studio or Handy, and
- # stamps them with the same status and subtask_id. Authorizing on its mere
- # existence would disable the kill switch the moment the 3MF finishes
- # downloading. Only a dispatch marker Bambuddy writes itself counts —
- # `billing_run_id` (minted per dispatch in the scheduler) or `created_by_id`
- # (carried over from the queue item that started it).
- if archive is not None and (archive.billing_run_id is not None or archive.created_by_id is not None):
- # Rehydrate the fast in-memory path for subsequent status frames. Include
- # both the archive filename and every normalized key reported by MQTT.
- _active_prints[(printer_id, archive.filename)] = archive.id
- for key in possible_keys:
- _active_prints[key] = archive.id
- return True
- # No dispatch marker. Before calling this someone else's print, check whether
- # Bambuddy has a job of its own running on this printer: a library-file
- # dispatch has no archive at send time, and an archive created seconds later
- # by `on_print_start` carries neither marker. The queue row, which the
- # scheduler commits to status="printing" before the MQTT send, is the one
- # durable record every Bambuddy print has. It cannot be tied to this
- # subtask_id, so it is grounds to defer, never to authorize — stopping a
- # print is irreversible, and refusing to act costs nothing but a log line.
- from backend.app.models.print_queue import PrintQueueItem
- dispatched_here = await db.scalar(
- select(PrintQueueItem.id)
- .where(
- PrintQueueItem.printer_id == printer_id,
- PrintQueueItem.status == "printing",
- )
- .limit(1)
- )
- if dispatched_here is not None:
- return None
- return False
- async def _send_kill_switch_provider_notification(
- printer_id: int,
- printer_name: str,
- data: dict,
- ) -> bool:
- """Send the immediate print-stopped provider notification.
- Returning a success flag lets the normal MQTT completion path retry when
- this early notification could not be delivered.
- """
- logger = logging.getLogger(__name__)
- try:
- async with async_session() as db:
- await notification_service.on_print_complete(
- printer_id,
- printer_name,
- "stopped",
- data,
- db,
- )
- return True
- except Exception as e:
- logger.warning(
- "[KILL SWITCH] Immediate provider notification failed for printer %s: %s",
- printer_id,
- e,
- )
- return False
- async def _kill_switch_notification_already_sent(task: asyncio.Task[bool] | None) -> bool:
- """Wait for an immediate kill-switch notification, if one was scheduled."""
- if task is None:
- return False
- try:
- return await task
- except Exception as e:
- logging.getLogger(__name__).warning("[KILL SWITCH] Notification task failed: %s", e)
- return False
- async def _get_plug_energy(plug, db) -> dict | None:
- """Get energy from plug regardless of type (Tasmota, Home Assistant, MQTT, or REST).
- For HA plugs, configures the service with current settings from DB.
- For MQTT plugs, returns data from the subscription service.
- For REST plugs, polls the status URL with JSON path extraction.
- """
- if plug.plug_type == "homeassistant":
- from backend.app.api.routes.settings import get_homeassistant_settings
- ha_settings = await get_homeassistant_settings(db)
- homeassistant_service.configure(ha_settings["ha_url"], ha_settings["ha_token"])
- return await homeassistant_service.get_energy(plug)
- elif plug.plug_type == "mqtt":
- # MQTT plugs report "today" energy, not lifetime total
- # For per-print tracking, we use "today" as the counter (resets at midnight)
- mqtt_data = mqtt_relay.smart_plug_service.get_plug_data(plug.id)
- if mqtt_data:
- return {
- "power": mqtt_data.power,
- "today": mqtt_data.energy,
- "total": mqtt_data.energy, # Use today as total for per-print calculations
- }
- return None
- elif plug.plug_type == "rest":
- from backend.app.services.rest_smart_plug import rest_smart_plug_service
- return await rest_smart_plug_service.get_energy(plug)
- else:
- return await tasmota_service.get_energy(plug)
- async def _record_energy_start(archive, printer_id: int, db, *, context: str = "") -> bool:
- """Capture the smart plug lifetime counter on the archive at print start.
- Persists `energy_start_kwh` on the archive row (#941) so per-print energy
- tracking survives a backend restart mid-print. The print-end handler reads
- this value back from the DB and computes the delta against the current
- plug counter.
- """
- _logger = logging.getLogger(__name__)
- try:
- candidates = await energy_plug_candidates(db, printer_id)
- if not candidates:
- _logger.info("[ENERGY] No smart plug for printer %s (archive %s)", printer_id, archive.id)
- return False
- selected = await select_energy_reading(candidates, _get_plug_energy, db)
- if selected is None:
- # Naming the plugs matters here: with several linked to one printer
- # this is the difference between "the meter is offline" and "you
- # linked only accessories" (#2859).
- _logger.warning(
- "[ENERGY] No plug on printer %s reports a lifetime energy counter for archive %s (tried: %s)",
- printer_id,
- archive.id,
- ", ".join(plug.name for plug in candidates),
- )
- return False
- plug, energy = selected
- archive.energy_start_kwh = float(energy["total"])
- await db.commit()
- _logger.info(
- "[ENERGY] Recorded starting energy%s for archive %s from plug '%s': %s kWh",
- f" ({context})" if context else "",
- archive.id,
- plug.name,
- energy["total"],
- )
- return True
- except Exception as e:
- _logger.warning("[ENERGY] Failed to record starting energy for archive %s: %s", archive.id, e)
- return False
- def register_expected_print(
- printer_id: int,
- filename: str,
- archive_id: int,
- ams_mapping: list[int] | None = None,
- created_by_id: int | None = None,
- cost_center_id: int | None = None,
- plate_id: int | None = None,
- ):
- """Register an expected print from reprint/scheduled so we don't create duplicate archives."""
- # Store with multiple filename variations to catch different naming patterns
- _expected_prints[(printer_id, filename)] = archive_id
- # Also store without .3mf extension if present
- if filename.endswith(".3mf"):
- base = filename[:-4]
- _expected_prints[(printer_id, base)] = archive_id
- _expected_prints[(printer_id, f"{base}.gcode")] = archive_id
- # Store AMS mapping for usage tracking at print completion
- if ams_mapping is not None:
- _print_ams_mappings[archive_id] = ams_mapping
- if cost_center_id is not None:
- _print_cost_center_ids[archive_id] = cost_center_id
- # Store plate_id for usage tracking when this is a single-plate dispatch from
- # a multi-plate 3MF — without this, the direct-Print path attributes the whole
- # file's filament total to the spool instead of just the printed plate (#1697).
- if plate_id is not None:
- _print_plate_ids[archive_id] = plate_id
- # Store created_by_id so the user start email can be sent even when the archive
- # itself has no created_by_id (e.g. library-file-based queue prints)
- if created_by_id is not None:
- _expected_print_creators[(printer_id, filename)] = created_by_id
- if filename.endswith(".3mf"):
- base = filename[:-4]
- _expected_print_creators[(printer_id, base)] = created_by_id
- _expected_print_creators[(printer_id, f"{base}.gcode")] = created_by_id
- # Record registration time for TTL-based eviction
- _registered_at = time.monotonic()
- _expected_print_registered_at[(printer_id, filename)] = _registered_at
- if filename.endswith(".3mf"):
- base = filename[:-4]
- _expected_print_registered_at[(printer_id, base)] = _registered_at
- _expected_print_registered_at[(printer_id, f"{base}.gcode")] = _registered_at
- logging.getLogger(__name__).info(
- f"Registered expected print: printer={printer_id}, file={filename}, archive={archive_id}, ams_mapping={ams_mapping}, plate_id={plate_id}"
- )
- def unregister_expected_print(printer_id: int, filename: str, archive_id: int) -> None:
- """Undo :func:`register_expected_print` when the print never went out.
- Registration has to happen *before* the MQTT print command, because the
- printer can report the print before the line after the send executes. So
- every path that registers and then fails to send — a cancel winning the
- #1853 CAS race, a ``start_print()`` that returns False, or any exception in
- between — leaves an expectation for a print that will never arrive.
- The TTL sweep evicts those after two hours, which is far longer than it
- takes a user to react to a failed dispatch by pressing print again: that
- reprint would be folded into the *old* archive and take the stale
- ``ams_mapping`` / ``plate_id`` with it. Hence the explicit inverse.
- Mirrors the sweep's rules, including the one that is easy to get wrong:
- ``_print_ams_mappings`` / ``_print_plate_ids`` are keyed by archive, not by
- file, so they may only be dropped once no live key still points at that
- archive.
- """
- keys = [(printer_id, filename)]
- if filename.endswith(".3mf"):
- base = filename[:-4]
- keys.append((printer_id, base))
- keys.append((printer_id, f"{base}.gcode"))
- removed = False
- for key in keys:
- if _expected_prints.pop(key, None) is not None:
- removed = True
- _expected_print_creators.pop(key, None)
- _expected_print_registered_at.pop(key, None)
- if archive_id not in set(_expected_prints.values()):
- _print_ams_mappings.pop(archive_id, None)
- _print_plate_ids.pop(archive_id, None)
- if removed:
- logging.getLogger(__name__).info(
- "Unregistered expected print: printer=%s, file=%s, archive=%s (print was never sent)",
- printer_id,
- filename,
- archive_id,
- )
- def _compute_run_filament_grams(
- status: str,
- archive_filament_used_grams: float | None,
- progress: float | int | None,
- usage_results: list[dict] | None,
- ) -> float | None:
- """Per-run filament for PrintLogEntry, partial- and tracker-aware (#1378, #1390).
- Priority for every status:
- 1. Sum of tracked spool deltas in ``usage_results`` (AMS-measured
- weight delta — same source that drives "Total Consumed" on the
- Inventory page, so Stats and Inventory totals stay aligned).
- 2. For ``completed``: the slicer estimate (no tracker available, fall
- back to the canonical "this print used X" value).
- 3. For partial statuses: ``estimate * progress%``.
- 4. ``None`` if nothing is known.
- """
- tracked_grams = sum(r.get("weight_used") or 0 for r in (usage_results or []))
- if tracked_grams > 0:
- return round(tracked_grams, 1)
- if status == "completed":
- return archive_filament_used_grams
- if archive_filament_used_grams:
- scale = max(0.0, min(((progress or 0) / 100.0), 1.0))
- if scale > 0:
- return round(archive_filament_used_grams * scale, 1)
- return None
- def _get_start_ams_mapping(data: dict, archive_id: int | None) -> list[int] | None:
- """Resolve AMS mapping for print start without consuming stored queue/reprint state."""
- stored_ams_mapping = data.get("ams_mapping")
- if not stored_ams_mapping and archive_id:
- stored_ams_mapping = _print_ams_mappings.get(archive_id)
- return stored_ams_mapping
- def _get_start_plate_id(archive_id: int | None) -> int | None:
- """Resolve plate_id for print start without consuming stored direct-Print state.
- Direct-Print of a single plate from a multi-plate 3MF registers plate_id in
- ``_print_plate_ids`` at dispatch time; this lets the spoolman / usage tracker
- read it back at print-start without popping (the entry is popped on print
- completion or TTL eviction, mirroring ``_print_ams_mappings``).
- """
- if archive_id is None:
- return None
- return _print_plate_ids.get(archive_id)
- def _partial_progress_scale(progress: int | float | None) -> float:
- """Clamp ``progress / 100`` into [0.0, 1.0] for partial-print scaling.
- Used by every site that multiplies a "would-have-used" slicer estimate
- down to "actually-used" for failed / cancelled / stopped prints. Centralised
- so the three sites in ``_background_notifications`` (and the per-plate
- override helper) can't drift apart on the coercion shape.
- """
- return max(0.0, min((progress or 0) / 100.0, 1.0))
- def _scope_notification_archive_data_to_plate(
- archive_data: dict,
- archive_file_path: str | None,
- plate_id: int | None,
- print_status: str,
- progress: int | float | None,
- base_dir: Path,
- ) -> dict:
- """Override summed-across-plates totals in ``archive_data`` with the values
- for ``plate_id`` so the completion notification reports what was actually
- printed, not the whole project (#1785).
- The 3MF parser at services/archive.py:200-264 sums ``prediction`` and
- ``weight`` across every plate of a multi-plate file (#1593) — correct for
- the archive card's "whole project" headline, wrong for the completion
- notification of a single-plate print. The queue UI already re-reads the
- 3MF per-plate at print_queue.py:272-285; this helper mirrors that for the
- notification payload (filament grams, time estimate, per-slot breakdown).
- No-ops when ``plate_id`` is None, the file is missing, or the 3MF carries
- no per-plate values — in every fail case the original ``archive_data`` is
- returned unchanged so the notification still sends.
- """
- if plate_id is None or not archive_file_path:
- return archive_data
- from backend.app.utils.threemf_tools import (
- extract_filament_usage_from_3mf,
- extract_print_time_from_3mf,
- )
- archive_path = base_dir / archive_file_path
- if not archive_path.exists():
- return archive_data
- plate_slots = extract_filament_usage_from_3mf(archive_path, plate_id)
- plate_grams = sum(f.get("used_g", 0) for f in plate_slots)
- plate_time = extract_print_time_from_3mf(archive_path, plate_id)
- scale = 1.0 if print_status == "completed" else _partial_progress_scale(progress)
- if plate_time:
- archive_data["print_time_seconds"] = plate_time
- # Gate both the grams headline AND the per-slot breakdown on the same
- # `plate_grams > 0` signal: if the 3MF carries per-plate filament rows but
- # they all sum to zero (slicer bug / re-slice without estimate), drop back
- # to the project-level grams the archive columns already provide rather
- # than ship a project-level headline next to an all-zero per-plate
- # breakdown.
- if plate_grams > 0:
- archive_data["actual_filament_grams"] = round(plate_grams * scale, 1)
- archive_data["filament_slots"] = [
- {
- "slot_id": s.get("slot_id"),
- "used_g": round((s.get("used_g") or 0) * scale, 1),
- "type": s.get("type", ""),
- "color": s.get("color", ""),
- }
- for s in plate_slots
- ]
- return archive_data
- def _extract_filament_data_from_mqtt(data: dict, ams_mapping: list[int] | None = None) -> dict[str, str]:
- """Best-effort filament metadata from the MQTT print-start snapshot.
- Used when the 3MF can't be downloaded (P1S/A1/P2S firmwares lock the
- file during print, see #1533) so the fallback PrintArchive still has
- enough filament info to support the inventory views and AMS-expansion
- planning the operator opens it for. Returns a dict with optional
- ``filament_type`` and ``filament_color`` keys in the same
- comma-separated format the 3MF extractor produces, so the rest of the
- codebase treats the fallback archive identically to a normal one.
- ``ams_mapping`` is the slicer's slot-per-print-filament list captured
- from the MQTT print payload (global tray IDs, possibly -1 for VT-tray
- entries). When supplied, only the slots actually consumed by this
- print contribute. Without it the function falls back to every loaded
- AMS slot — less accurate but still useful.
- Accepts both the raw inner payload (``{"ams": {"ams": [...]}, ...}``)
- that the unit tests pass directly, AND the on_print_start callback
- shape (``{"raw_data": {"ams": {"ams": [...]}, ...}, ...}``) the
- bambu_mqtt service hands to main.py at runtime. The original
- ``_extract_filament_data_from_mqtt(data)`` shipped in #1533 only
- handled the inner shape and silently returned ``{}`` for every real
- print start, leaving fallback archives' filament fields NULL — the
- exact regression the fix was meant to close. Reported with a log
- proving the AMS state was right there at
- ``data["raw_data"]["ams"]["ams"][0]["tray"][0]`` (#1533 follow-up).
- """
- result: dict[str, str] = {}
- # Look at the on_print_start wrapper first, then the inner shape.
- raw_data = (data or {}).get("raw_data")
- ams_root = (raw_data or {}).get("ams") if isinstance(raw_data, dict) else None
- if not isinstance(ams_root, dict):
- ams_root = (data or {}).get("ams") or {}
- ams_units = ams_root.get("ams") if isinstance(ams_root, dict) else None
- if not isinstance(ams_units, list) or not ams_units:
- return result
- # Map global tray id (unit * 4 + tray) → (type, color).
- loaded: dict[int, tuple[str, str]] = {}
- for unit in ams_units:
- if not isinstance(unit, dict):
- continue
- try:
- unit_id = int(unit.get("id", 0))
- except (TypeError, ValueError):
- continue
- for tray in unit.get("tray") or []:
- if not isinstance(tray, dict):
- continue
- try:
- tray_id = int(tray.get("id", 0))
- except (TypeError, ValueError):
- continue
- ttype = (tray.get("tray_type") or "").strip()
- tcolor = (tray.get("tray_color") or "").strip().upper()
- if not ttype:
- continue # Empty / unloaded slot.
- loaded[unit_id * 4 + tray_id] = (ttype, tcolor)
- if not loaded:
- return result
- if ams_mapping:
- used_ids = [int(x) for x in ams_mapping if isinstance(x, (int, float)) and int(x) >= 0]
- filaments = [loaded[g] for g in used_ids if g in loaded]
- if not filaments:
- return result # Mapping points entirely at slots we have no data for.
- else:
- filaments = [loaded[g] for g in sorted(loaded.keys())]
- types_joined = ",".join(f[0] for f in filaments)
- colors_joined = ",".join(f[1] for f in filaments if f[1])
- # Column limits per backend/app/models/archive.py: filament_type=50,
- # filament_color=200.
- if types_joined:
- result["filament_type"] = types_joined[:50]
- if colors_joined:
- result["filament_color"] = colors_joined[:200]
- return result
- def _maybe_start_layer_timelapse(printer, printer_id: int, archive_id: int) -> bool:
- """Start a layer-timelapse session for *archive_id* when the printer has
- an external camera configured. Returns True if a session was started.
- Three call sites in on_print_start (expected-archive promotion, fallback
- archive creation, fresh-archive creation) used to inline this same
- if-block; the inline copies kept drifting (#1353 fixed only one of them
- on the first pass). Centralising the conditional + call here makes the
- contract testable in isolation and keeps the three sites locked in step.
- """
- if not (printer.external_camera_enabled and printer.external_camera_url):
- return False
- from backend.app.services.layer_timelapse import start_session
- start_session(
- printer_id,
- archive_id,
- printer.external_camera_url,
- printer.external_camera_type or "mjpeg",
- snapshot_url=printer.external_camera_snapshot_url,
- rotation=getattr(printer, "camera_rotation", 0),
- )
- logging.getLogger(__name__).info("Started layer timelapse for printer %s, archive %s", printer_id, archive_id)
- return True
- def _format_hms_error_summary(hms_errors: list[dict]) -> str | None:
- """Build a human-readable failure reason from MQTT hms_errors for PrintQueueItem.error_message.
- Each entry has keys: code ('0x4038'), attr (32-bit int), module, severity, and
- — since #2926 — the description the parser already resolved, which is preferred
- when present so the queue's failure reason reads the same as the status
- response. The short code still produces the bracketed label, and still
- resolves the sentence for a caller whose entries predate the field. Falls back
- to the bare short code when no description is on file. Returns None for an
- empty list so callers can leave error_message unset.
- """
- if not hms_errors:
- return None
- from backend.app.services.hms_errors import get_error_description
- parts: list[str] = []
- for err in hms_errors:
- try:
- # `_hms_short_code` rather than a local derivation: this one used to
- # format the error without masking it to 16 bits, so an `hms[]` entry
- # whose code carries an alert-level group produced a five-digit label
- # like "0500_3000A" — not a code the user can look up, and never a
- # catalogue key, so the sentence was lost with it.
- short_code = _hms_short_code(err.get("attr", 0), err.get("code", 0))
- except (TypeError, ValueError):
- continue
- description = err.get("description") or get_error_description(short_code)
- parts.append(f"[{short_code}] {description}" if description else f"[{short_code}]")
- return "; ".join(parts) if parts else None
- async def _bump_library_file_usage_if_completed(db, item, queue_status: str) -> None:
- """Increment LibraryFile.print_count and stamp last_printed_at when a queued
- print completes successfully. Gated to status=='completed': failed, cancelled
- and aborted prints do not count as usage. Caller is responsible for committing
- the session. No-op when the queue item has no linked library file (e.g. reprints
- from an archive). See #1008."""
- if queue_status != "completed" or item.library_file_id is None:
- return
- from backend.app.models.library import LibraryFile
- lib_file = await db.scalar(select(LibraryFile).where(LibraryFile.id == item.library_file_id))
- if lib_file is None:
- return
- lib_file.print_count = (lib_file.print_count or 0) + 1
- lib_file.last_printed_at = datetime.now(timezone.utc)
- def mark_printer_stopped_by_user(printer_id: int) -> None:
- """Mark that the active print on this printer was stopped by the user from the queue UI.
- When on_print_complete fires with status 'failed' for a printer in this set we
- reclassify it as 'cancelled' so the correct 'print stopped' notification is sent
- rather than a 'print failed' notification.
- """
- _user_stopped_printers.add(printer_id)
- logging.getLogger(__name__).info("Marked printer %s as user-stopped from queue", printer_id)
- _last_status_broadcast: dict[int, str] = {}
- # Track printers where we've updated nozzle_count
- _nozzle_count_updated: set[int] = set()
- async def _maybe_notify_printer_offline(printer_id: int) -> None:
- """Wait the debounce window then fire `on_printer_offline` if the printer
- is still offline.
- Scheduled by `on_printer_status_change` on the connected → disconnected
- edge (#1752). Cancelled by the same handler if the printer reconnects
- before the window elapses, so a single MQTT blip + recovery doesn't
- notify. Both the staleness-detector path (`bambu_mqtt.py::check_staleness`)
- and the smart-plug power-off path (`printer_manager.mark_printer_offline`)
- route through the same status-change callback, so this covers both.
- """
- logger = logging.getLogger(__name__)
- try:
- await asyncio.sleep(_PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS)
- still_offline = not printer_manager.is_connected(printer_id)
- logger.info(
- "[#1752] Printer %s offline debounce elapsed: still_offline=%s",
- printer_id,
- still_offline,
- )
- if not still_offline:
- return
- async with async_session() as db:
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if not printer:
- logger.warning(
- "[#1752] Printer %s missing from DB at offline-notify time; skipping",
- printer_id,
- )
- return
- logger.info(
- "[#1752] Dispatching on_printer_offline for printer %s (%s)",
- printer_id,
- printer.name,
- )
- await notification_service.on_printer_offline(printer_id, printer.name, db)
- except asyncio.CancelledError:
- raise
- except Exception as e:
- logger.warning("Printer offline notification failed for printer %s: %s", printer_id, e)
- finally:
- _printer_offline_notify_tasks.pop(printer_id, None)
- async def on_printer_status_change(printer_id: int, state: PrinterState):
- """Handle printer status changes - broadcast via WebSocket."""
- # Connected-edge reconciliation (#1542 follow-up). When the printer
- # transitions disconnected → connected — which covers both Bambuddy
- # startup (no prior connection) and a mid-session MQTT reconnect — fire
- # `reconcile_stale_active_prints` exactly once for this connection so
- # any archive still in `status="printing"` that can't actually be
- # running anymore (printer IDLE / different subtask / empty subtask)
- # gets a synthesised PRINT COMPLETE. Without this, a print that
- # finished during a disconnect window + a smart-plug power cycle
- # leaves the .3mf on the SD card and the firmware ghost-replays it on
- # next boot. Reconciliation runs concurrently — it must not block the
- # WebSocket dedup / broadcast logic below, and the connected edge is
- # marked True BEFORE the await so concurrent status updates inside
- # the same connection don't re-trigger reconciliation.
- #
- # Wait for a real push_status before reconciling (#1679): MQTT
- # `_on_connect` broadcasts `state` IMMEDIATELY after the broker accepts
- # the connection, BEFORE `_request_push_all` round-trips. At that
- # instant the `PrinterState` is still on construction defaults — most
- # importantly `state.state == "unknown"` and `state.subtask_name == ""`.
- # If reconcile spawns here, every in-flight archive falls through to
- # the empty-subtask_name trigger and gets synthesised `aborted`, which
- # creates a duplicate archive on the real PRINT COMPLETE and
- # double-counts filament. Gating on `state.state ∉ ("", "unknown")`
- # keeps the #1542 mechanism intact: once the first real push_status
- # updates `state.state` (RUNNING / IDLE / FINISH / …), this handler
- # fires again with the flag still False — reconcile then runs against
- # actual evidence.
- state_known = bool(state.state) and state.state.upper() not in ("", "UNKNOWN")
- if state.connected and state_known and not _printer_reconciled_since_connect.get(printer_id, False):
- _printer_reconciled_since_connect[printer_id] = True
- spawn_background_task(
- reconcile_stale_active_prints(printer_id),
- name=f"reconcile-stale-prints-{printer_id}",
- )
- elif not state.connected and _printer_reconciled_since_connect.get(printer_id, False):
- # Re-arm so the next reconnect triggers reconciliation again.
- _printer_reconciled_since_connect[printer_id] = False
- # Same edge, for the calibration table the AMS card reads its K values from.
- #
- # Also gated on knowing a nozzle diameter, which is what decides *which*
- # tables to ask for. A `state_known` gate alone is not enough: the first
- # real push_status is what makes the state known, and the nozzle fields do
- # not always arrive in it. Latching there would spend this connection's one
- # attempt on a printer that could not yet say what was fitted.
- nozzle_known = any(n.nozzle_diameter for n in (state.nozzles or []))
- if (
- state.connected
- and state_known
- and nozzle_known
- and not _printer_kprofiles_primed_since_connect.get(printer_id, False)
- ):
- _printer_kprofiles_primed_since_connect[printer_id] = True
- spawn_background_task(
- prime_kprofile_table(printer_id),
- name=f"prime-kprofiles-{printer_id}",
- )
- elif not state.connected and _printer_kprofiles_primed_since_connect.get(printer_id, False):
- _printer_kprofiles_primed_since_connect[printer_id] = False
- # Offline-notification edge (#1752): schedule `on_printer_offline` on
- # connected → disconnected. The "back online" channel is already covered
- # by the print-failure notification (firmware reports gcode_state=FAILED
- # on reconnect of an interrupted print), so we don't add a symmetric
- # online event here.
- prev_connected = _printer_last_connected.get(printer_id)
- _printer_last_connected[printer_id] = state.connected
- if prev_connected is True and not state.connected:
- existing = _printer_offline_notify_tasks.get(printer_id)
- if existing is None or existing.done():
- logging.getLogger(__name__).info(
- "[#1752] Printer %s connected→disconnected edge; scheduling offline notification in %.0fs",
- printer_id,
- _PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS,
- )
- _printer_offline_notify_tasks[printer_id] = asyncio.create_task(
- _maybe_notify_printer_offline(printer_id),
- name=f"printer-offline-notify-{printer_id}",
- )
- elif state.connected:
- pending = _printer_offline_notify_tasks.pop(printer_id, None)
- if pending is not None and not pending.done():
- logging.getLogger(__name__).info(
- "[#1752] Printer %s reconnected before debounce; cancelling pending offline notification",
- printer_id,
- )
- pending.cancel()
- # Only broadcast if something meaningful changed (reduce WebSocket spam)
- # Include rounded temperatures to detect meaningful temp changes (within 1 degree)
- temps = state.temperatures or {}
- nozzle_temp = round(temps.get("nozzle", 0))
- bed_temp = round(temps.get("bed", 0))
- nozzle_2_temp = round(temps.get("nozzle_2", 0)) if "nozzle_2" in temps else ""
- chamber_temp = round(temps.get("chamber", 0)) if "chamber" in temps else ""
- # Auto-detect dual-nozzle printers from MQTT temperature data
- if "nozzle_2" in temps and printer_id not in _nozzle_count_updated:
- _nozzle_count_updated.add(printer_id)
- # Update nozzle_count in database
- async with async_session() as db:
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if printer and printer.nozzle_count != 2:
- printer.nozzle_count = 2
- await db.commit()
- logging.getLogger(__name__).info(
- f"Auto-detected dual-nozzle printer {printer_id}, updated nozzle_count=2"
- )
- # Include target temps for heating phase detection
- bed_target = round(temps.get("bed_target", 0))
- nozzle_target = round(temps.get("nozzle_target", 0))
- # Include tray_now and vt_tray hash so external spool changes trigger broadcasts
- vt_tray_key = hash(str(state.raw_data.get("vt_tray", []))) if state.raw_data else 0
- # Include AMS dry_time and tray state values so drying/slot changes trigger broadcasts
- ams_dry_key = tuple(a.get("dry_time", 0) for a in (state.raw_data.get("ams") or [])) if state.raw_data else ()
- # Include tray states so load/unload transitions (state 11→10) trigger broadcasts (#784)
- #
- # The filament identity fields are here because Configure Slot writes
- # exactly those and nothing else. Re-configuring a slot from PLA to another
- # brand or colour of PLA leaves id/tray_type/state identical, so the key
- # matched, this function returned before broadcasting, and the card kept
- # showing the old filament until the 30s fallback poll or a page reload —
- # even though the configure route asks the printer for a fresh pushall and
- # that push does carry the new values. Reset always worked, because it
- # clears tray_type.
- #
- # These fields only change when someone configures a slot or swaps a spool,
- # so unlike temperature or progress they add no broadcast traffic mid-print.
- ams_tray_key = (
- tuple(
- (
- t.get("id"),
- t.get("tray_type", ""),
- t.get("state"),
- t.get("tray_color", ""),
- t.get("tray_info_idx", ""),
- t.get("tray_sub_brands", ""),
- t.get("cali_idx"),
- )
- for a in (state.raw_data.get("ams") or [])
- for t in a.get("tray", [])
- )
- if state.raw_data
- else ()
- )
- # Filament Track Switch: which inlet each AMS is bound to, and whether the
- # accessory is fitted at all. Neither is in ams_tray_key (it is per-tray) nor
- # in the AMS change-hash (tray fields only, and widening that would fire
- # spurious Spoolman syncs), so without them a "Join IN-B" on the printer
- # screen changed no key at all and the card's inlet badges sat stale until a
- # reload. Like the filament-backup flag, these only move when someone
- # reconfigures the machine, so they add no mid-print broadcast traffic.
- fts_key = (
- state.fila_switch.installed if state.fila_switch else False,
- tuple(sorted(state.ams_switch_inlet.items())),
- # Which hotend holds which slot. Unlike the two above this does move
- # mid-print, on every filament change — but only between discrete slots,
- # so it adds a push per toolchange, not a stream. The AMS slot menu needs
- # it live: it decides which hotend the Load dialog may offer and whether
- # Unload has anything to act on.
- tuple(
- sorted(
- ((ext, slot.ams_id, slot.slot_id, slot.has_filament) for ext, slot in state.extruder_slots.items()),
- # Sort on the extruder id alone: the other members are nullable
- # and comparing None with an int raises.
- key=lambda entry: entry[0],
- )
- ),
- )
- status_key = (
- f"{state.connected}:{state.state}:{state.progress}:{state.layer_num}:"
- f"{nozzle_temp}:{bed_temp}:{nozzle_2_temp}:{chamber_temp}:"
- f"{state.stg_cur}:{bed_target}:{nozzle_target}:"
- f"{state.cooling_fan_speed}:{state.big_fan1_speed}:{state.big_fan2_speed}:"
- f"{state.chamber_light}:{state.active_extruder}:{state.tray_now}:{vt_tray_key}:"
- f"{ams_dry_key}:{ams_tray_key}:{state.door_open}:{state.ams_filament_backup}:{fts_key}"
- )
- is_active_print = state.state in _ACTIVE_PRINT_STATES
- if not is_active_print:
- _unauthorized_print_kill_sent.discard(printer_id)
- elif printer_id in _unauthorized_print_kill_sent:
- # stop_print() was already sent for this print; avoid all further
- # ownership and settings work until the printer leaves an active state.
- pass
- elif _is_bambuddy_authorized_print_in_memory(printer_id, state):
- # Normal Bambuddy-started prints stay entirely on the in-memory path.
- _unauthorized_print_kill_sent.discard(printer_id)
- else:
- kill_switch_enabled = False
- authorization: bool | None = None
- status_logger = logging.getLogger(__name__)
- try:
- kill_switch_enabled = await _is_printer_kill_switch_enabled_cached()
- if kill_switch_enabled:
- async with async_session() as db:
- authorization = await _is_bambuddy_authorized_print(printer_id, state, db)
- except Exception as e:
- # Fail safe: a database/reconciliation error must never turn into an
- # irreversible stop of a print whose ownership is still unknown.
- authorization = None
- status_logger.warning(
- "[KILL SWITCH] Failed to reconcile print authorization for printer %s: %s", printer_id, e
- )
- if not kill_switch_enabled or authorization is True:
- _unauthorized_print_kill_sent.discard(printer_id)
- elif authorization is None:
- _unauthorized_print_kill_sent.discard(printer_id)
- status_logger.debug(
- "[KILL SWITCH] Deferring authorization for printer %s until archive state is reconciled",
- printer_id,
- )
- else:
- try:
- stopped = printer_manager.stop_print(printer_id)
- if stopped:
- _unauthorized_print_kill_sent.add(printer_id)
- printer_info = printer_manager.get_printer(printer_id)
- printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
- filename = state.subtask_name or state.gcode_file or state.current_print or "Unknown"
- notification_data = {
- "status": "stopped",
- "filename": state.gcode_file or state.current_print or "",
- "subtask_name": state.subtask_name or "",
- "progress": state.progress,
- "reason": "unauthorized_print",
- }
- status_logger.warning(
- "[KILL SWITCH] Stopped unauthorized print on printer %s (state=%s)",
- printer_id,
- state.state,
- )
- try:
- await ws_manager.broadcast(
- {
- "type": "kill_switch_triggered",
- "printer_id": printer_id,
- "printer_name": printer_name,
- "filename": filename,
- "reason": "unauthorized_print",
- }
- )
- except Exception as e:
- status_logger.warning(
- "[KILL SWITCH] WebSocket notification failed for printer %s: %s", printer_id, e
- )
- previous_task = _kill_switch_notification_tasks.pop(printer_id, None)
- if previous_task is not None and not previous_task.done():
- previous_task.cancel()
- _kill_switch_notification_tasks[printer_id] = spawn_background_task(
- _send_kill_switch_provider_notification(printer_id, printer_name, notification_data),
- name=f"kill-switch-notification-{printer_id}",
- )
- else:
- status_logger.warning(
- "[KILL SWITCH] Could not stop unauthorized print on printer %s (state=%s)",
- printer_id,
- state.state,
- )
- except Exception as e:
- status_logger.warning(
- "[KILL SWITCH] Failed to stop unauthorized print on printer %s: %s", printer_id, e
- )
- # MQTT relay - publish status (before dedup check - always publish to MQTT)
- try:
- printer_info = printer_manager.get_printer(printer_id)
- if printer_info:
- await mqtt_relay.on_printer_status(
- printer_id,
- state,
- printer_info.name,
- printer_info.serial_number,
- printer_manager.is_awaiting_plate_clear(printer_id),
- )
- except Exception:
- pass # Don't fail status callback if MQTT fails
- if _last_status_broadcast.get(printer_id) == status_key:
- return # No change, skip WebSocket broadcast
- _last_status_broadcast[printer_id] = status_key
- # Check for progress milestone notifications (25%, 50%, 75%)
- progress = state.progress or 0
- is_printing = state.state in ("RUNNING", "PRINTING")
- if is_printing and progress > 0:
- # Determine which milestone we've reached
- current_milestone = 0
- if progress >= 75:
- current_milestone = 75
- elif progress >= 50:
- current_milestone = 50
- elif progress >= 25:
- current_milestone = 25
- last_milestone = _last_progress_milestone.get(printer_id, 0)
- # If we've crossed a new milestone, send notification
- if current_milestone > last_milestone:
- _last_progress_milestone[printer_id] = current_milestone
- try:
- from backend.app.models.printer import Printer
- # Read the printer in a short session and release the connection
- # BEFORE the ~15s camera snapshot below — holding it across the grab
- # pinned a pooled connection per milestone, per printer (issue #2572).
- async with async_session() as db:
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- printer_name = printer.name if printer else f"Printer {printer_id}"
- filename = state.subtask_name or state.gcode_file or "Unknown"
- # remaining_time is in minutes, convert to seconds for notification
- remaining_time_seconds = state.remaining_time * 60 if state.remaining_time else None
- # Capture camera snapshot for notification image attachment (no DB held).
- image_data = await _capture_snapshot_for_notification(printer_id, printer, logging.getLogger(__name__))
- # Notification send needs a session (provider/template lookups).
- async with async_session() as db:
- await notification_service.on_print_progress(
- printer_id,
- printer_name,
- filename,
- current_milestone,
- db,
- remaining_time_seconds,
- image_data=image_data,
- )
- except Exception as e:
- logging.getLogger(__name__).warning(f"Progress milestone notification failed: {e}")
- elif progress < 5:
- # Reset milestone tracking when print restarts or new print begins
- _last_progress_milestone[printer_id] = 0
- _first_layer_notified[printer_id] = False
- # HMS error codes that should not trigger notifications even though they
- # have known descriptions (e.g. user-initiated actions, not real errors).
- _HMS_NOTIFICATION_SUPPRESS = {
- "0500_400E", # Printing was cancelled (user action, not an error)
- }
- # Check for new HMS errors and send notifications
- current_hms_errors = getattr(state, "hms_errors", []) or []
- if current_hms_errors:
- # Build set of current error codes (using attr for uniqueness)
- current_error_codes = {f"{e.attr:08x}" for e in current_hms_errors}
- previously_notified = _notified_hms_errors.get(printer_id, set())
- # Find new errors that haven't been notified yet
- new_error_codes = current_error_codes - previously_notified
- # Update tracking immediately to prevent duplicate notifications from concurrent callbacks
- _notified_hms_errors[printer_id] = current_error_codes
- _hms_last_seen[printer_id] = time.time()
- if new_error_codes:
- # Get the actual new errors for the notification
- # Filter to severity >= 2 (skip informational/status messages like H2D sends)
- new_errors = [e for e in current_hms_errors if f"{e.attr:08x}" in new_error_codes and e.severity >= 2]
- try:
- from backend.app.models.printer import Printer
- # Read the printer in a short session and release the connection
- # BEFORE the ~15s camera snapshot below (issue #2572).
- async with async_session() as db:
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- printer_name = printer.name if printer else f"Printer {printer_id}"
- # Format error details for notification
- # Module 0x07 = AMS/Filament, 0x05 = Nozzle, 0x0C = Motion Controller, etc.
- module_names = {
- 0x03: "Print/Task",
- 0x05: "Nozzle/Extruder",
- 0x07: "AMS/Filament",
- 0x0C: "Motion Controller",
- 0x12: "Chamber",
- }
- # Capture camera snapshot once for all error notifications (no DB held).
- error_image_data = await _capture_snapshot_for_notification(
- printer_id, printer, logging.getLogger(__name__)
- )
- # Notification sends need a session (provider/template lookups).
- async with async_session() as db:
- sent_count = 0
- for error in new_errors:
- module_name = module_names.get(error.module, f"Module 0x{error.module:02X}")
- # Build short code like "0700_8010"
- # Mask to 16 bits to handle printers that send larger values
- error_code_int = int(error.code.replace("0x", ""), 16) if error.code else 0
- error_code_masked = error_code_int & 0xFFFF
- short_code = f"{(error.attr >> 16) & 0xFFFF:04X}_{error_code_masked:04X}"
- # Only notify for errors with known descriptions — printers
- # send many undocumented/phantom codes that aren't real errors.
- # Resolved at parse time (#2926); short_code is still needed
- # for the suppression set below.
- description = error.description
- if not description or short_code in _HMS_NOTIFICATION_SUPPRESS:
- continue
- error_type = f"{module_name} Error"
- error_detail = description
- await notification_service.on_printer_error(
- printer_id, printer_name, error_type, db, error_detail, image_data=error_image_data
- )
- sent_count += 1
- if sent_count:
- logging.getLogger(__name__).info(
- f"[HMS] Sent notification for {sent_count} error(s) on printer {printer_id}"
- )
- # Also publish to MQTT relay (no DB).
- printer_info = printer_manager.get_printer(printer_id)
- if printer_info:
- errors_data = [
- {
- "code": e.code,
- "attr": e.attr,
- "module": e.module,
- "severity": e.severity,
- }
- for e in new_errors
- ]
- await mqtt_relay.on_printer_error(
- printer_id, printer_info.name, printer_info.serial_number, errors_data
- )
- except Exception as e:
- logging.getLogger(__name__).warning(f"HMS error notification failed: {e}")
- else:
- # No HMS errors — only clear tracking after a grace period to prevent
- # flapping errors (brief hms:[] gaps) from re-triggering notifications.
- # Some HMS codes (e.g. chamber temp regulation during PETG prints) toggle
- # on/off every few seconds as conditions fluctuate around thresholds.
- if printer_id in _notified_hms_errors:
- last_seen = _hms_last_seen.get(printer_id, 0)
- if time.time() - last_seen >= _HMS_CLEAR_GRACE_SECONDS:
- _notified_hms_errors.pop(printer_id, None)
- _hms_last_seen.pop(printer_id, None)
- await ws_manager.send_printer_status(
- printer_id,
- printer_state_to_dict(
- state,
- printer_id,
- printer_manager.get_model(printer_id),
- printer_manager.get_drying_targets(printer_id),
- ),
- )
- def _is_bambu_uuid(tray_uuid: str) -> bool:
- """Check if a tray UUID looks like a valid Bambu Lab RFID UUID (non-empty, non-zero)."""
- return bool(tray_uuid) and tray_uuid not in ("", "0" * len(tray_uuid))
- async def on_fts_inlet_change(printer_id: int, ams_id: int, inlet: str):
- """Re-point a moved AMS's K-profiles at the nozzle it now feeds.
- K-profiles are per-nozzle and the printer's calibration table is numbered
- per-nozzle, but a tray holds exactly one ``cali_idx``. Moving an AMS to the
- switch's other inlet therefore silently invalidates every configured slot in
- it: the index stays put and now resolves against the other nozzle's table.
- Measured on the maintainer's H2C — one spool calibrated 0.018 on the left
- and 0.020 on the right kept the left profile after the move, and a manual
- RFID re-read only re-asserted the same wrong one.
- Configuring a slot is a deliberate preparation step, so this re-selects
- rather than re-configures: only the calibration binding moves, and only for
- slots whose spool already has a stored profile for the new nozzle. A slot
- Bambuddy knows nothing about is left exactly as the operator left it.
- """
- logger = logging.getLogger(__name__)
- target_extruder = extruder_for_inlet(inlet)
- if target_extruder is None:
- return
- client = printer_manager.get_client(printer_id)
- state = printer_manager.get_status(printer_id)
- if not client or not state or not state.raw_data:
- return
- # The nozzle the AMS now feeds -- the diameter of the TARGET extruder, not
- # of nozzle 0. On a machine with two sizes fitted, moving the inlet changes
- # the nozzle width, which changes both the K profile to select and the
- # preset the slot should carry.
- nozzle_diameter = nozzle_diameter_for_extruder(state, target_extruder, printer_manager.get_model(printer_id))
- ams_raw = state.raw_data.get("ams")
- ams_list = ams_raw.get("ams", []) if isinstance(ams_raw, dict) else ams_raw if isinstance(ams_raw, list) else []
- unit = next((u for u in ams_list if str(u.get("id")) == str(ams_id)), None)
- if not unit:
- return
- try:
- async with async_session() as db:
- for tray in unit.get("tray", []):
- tray_id = int(tray.get("id", -1))
- if tray_id < 0 or not tray.get("tray_type"):
- continue
- current_idx = tray.get("cali_idx")
- profile = await find_slot_kprofile_for_extruder(
- db,
- printer_id,
- ams_id,
- tray_id,
- target_extruder,
- nozzle_diameter,
- printer_manager.get_model(printer_id),
- nozzle_flow_for_extruder(state, target_extruder, printer_manager.get_model(printer_id)),
- )
- if profile is None or profile.cali_idx is None:
- continue
- if current_idx == profile.cali_idx:
- continue # Already on the right one.
- logger.info(
- "[Printer %s] AMS %s slot %s moved to inlet %s (nozzle %s): "
- "re-selecting K-profile %s (cali_idx %s -> %s, K=%s)",
- printer_id,
- ams_id,
- tray_id,
- inlet,
- target_extruder,
- profile.name,
- current_idx,
- profile.cali_idx,
- profile.k_value,
- )
- client.extrusion_cali_sel(
- ams_id=ams_id,
- tray_id=tray_id,
- cali_idx=profile.cali_idx,
- filament_id=printer_safe_filament_id(profile.filament_id, tray.get("tray_info_idx", "")),
- nozzle_diameter=nozzle_diameter,
- )
- except Exception as e:
- logger.warning("[Printer %s] Could not re-apply K-profiles after inlet move: %s", printer_id, e)
- async def on_ams_change(printer_id: int, ams_data: list):
- """Handle AMS data changes - sync to Spoolman if enabled and auto mode."""
- logger = logging.getLogger(__name__)
- # Snapshot BEFORE any await: if a print is active, skip weight sync later.
- # on_print_complete may pop _active_sessions during our awaits (#880).
- from backend.app.services.usage_tracker import _active_sessions
- _print_active = printer_id in _active_sessions
- # A slot that reports empty while a print is running is a filament runout,
- # not a spool swap: the spool is still physically in the AMS, just
- # consumed. Dropping either inventory backend's slot link there loses the
- # only record of which spool fed the print, so the completion path can't
- # charge the runout segment to anything. Both cleanup passes below consult
- # this; computed once, up front, so neither depends on the other having run.
- _unlink_state = printer_manager.get_status(printer_id)
- printing_now = (getattr(_unlink_state, "state", "") or "").upper() in ("RUNNING", "PAUSE")
- # MQTT relay - publish AMS change
- try:
- printer_info = printer_manager.get_printer(printer_id)
- if printer_info:
- await mqtt_relay.on_ams_change(printer_id, printer_info.name, printer_info.serial_number, ams_data)
- except Exception:
- pass # Don't fail AMS callback if MQTT fails
- # Broadcast AMS change via WebSocket (bypasses status_key deduplication)
- # This ensures frontend gets immediate updates when AMS slots are configured
- try:
- state = printer_manager.get_status(printer_id)
- if state:
- logger.info("[Printer %s] Broadcasting AMS change via WebSocket", printer_id)
- await ws_manager.send_printer_status(
- printer_id,
- printer_state_to_dict(
- state,
- printer_id,
- printer_manager.get_model(printer_id),
- printer_manager.get_drying_targets(printer_id),
- ),
- )
- except Exception as e:
- logger.warning("Failed to broadcast AMS change for printer %s: %s", printer_id, e)
- from backend.app.utils.color_utils import colors_similar as _colors_similar
- # Auto-unlink spool assignments with stale fingerprints
- try:
- async with async_session() as db:
- from sqlalchemy.orm import selectinload
- from backend.app.api.routes.inventory import _find_tray_in_ams_data
- from backend.app.models.spool import Spool as _Spool
- from backend.app.models.spool_assignment import SpoolAssignment as SA
- from backend.app.services.inventory_mode import spoolman_owns_assignments
- # Built-in assignments only. Since #2812 they survive a switch to
- # Spoolman mode rather than being deleted by it, and this pass ends
- # in ``db.delete`` — left ungated it would unlink them one slot at a
- # time as the AMS contents changed under the other mode, undoing the
- # preservation more slowly but just as completely.
- assignments = []
- if not await spoolman_owns_assignments(db):
- result = await db.execute(
- select(SA)
- .where(SA.printer_id == printer_id)
- .options(selectinload(SA.spool).selectinload(_Spool.k_profiles))
- )
- assignments = result.scalars().all()
- # ``printing_now`` (top of this function) keeps a runout from
- # unlinking the spool that fed the print — the next idle-time pass
- # unlinks it if the user really did take it out.
- stale = []
- for assignment in assignments:
- # External spool assignments (ams_id=255) live in vt_tray, not AMS data
- if assignment.ams_id == 255:
- ps = printer_manager.get_status(printer_id)
- vt_tray_raw = ps.raw_data.get("vt_tray", []) if ps else []
- ext_id = assignment.tray_id + 254 # 0→254, 1→255
- current_tray = None
- for vt in vt_tray_raw:
- if isinstance(vt, dict) and int(vt.get("id", 254)) == ext_id:
- current_tray = vt
- break
- if not current_tray:
- # vt_tray data may not have arrived yet — keep assignment
- continue
- else:
- current_tray = _find_tray_in_ams_data(ams_data, assignment.ams_id, assignment.tray_id)
- if not current_tray:
- if printing_now:
- logger.info(
- "Auto-unlink skipped: spool %d AMS%d-T%d — slot empty during a running print (runout?)",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- continue
- logger.info(
- "Auto-unlink: spool %d AMS%d-T%d — tray not found in AMS data (slot empty?)",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- stale.append(assignment) # Slot empty
- elif _is_bambu_uuid(current_tray.get("tray_uuid", "")):
- # A Bambu Lab spool is in this slot — check if it's the same spool
- # that's currently assigned. If yes, keep the assignment (avoids
- # unnecessary unlink/re-assign/ams_filament_setting cycle that clears
- # the printer's filament preset on every startup).
- tray_uuid = current_tray.get("tray_uuid", "")
- tag_uid = current_tray.get("tag_uid", "")
- spool = assignment.spool
- spool_matches = False
- if spool:
- if (spool.tray_uuid and spool.tray_uuid.upper() == tray_uuid.upper()) or (
- spool.tag_uid
- and tag_uid
- and tag_uid != "0000000000000000"
- and spool.tag_uid.upper() == tag_uid.upper()
- ):
- spool_matches = True
- if spool_matches:
- # Same BL spool still in slot — keep assignment, update fingerprint if needed
- cur_color = current_tray.get("tray_color", "")
- cur_type = current_tray.get("tray_type", "")
- fp_color = assignment.fingerprint_color or ""
- fp_type = assignment.fingerprint_type or ""
- if cur_color.upper() != fp_color.upper() or cur_type.upper() != fp_type.upper():
- assignment.fingerprint_color = cur_color
- assignment.fingerprint_type = cur_type
- logger.debug(
- "Auto-unlink: spool %d AMS%d-T%d — same BL spool, updated fingerprint",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- continue
- # Different BL spool or unrecognized — unlink so auto-assign can match
- logger.info(
- "Auto-unlink: spool %d AMS%d-T%d — different Bambu Lab spool detected (uuid=%s)",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- tray_uuid,
- )
- stale.append(assignment)
- else:
- cur_color = current_tray.get("tray_color", "")
- cur_type = current_tray.get("tray_type", "")
- cur_state = current_tray.get("state")
- fp_color = assignment.fingerprint_color or ""
- fp_type = assignment.fingerprint_type or ""
- # SpoolBuddy pre-config replay: fingerprint_type empty means
- # the slot was empty when the user pre-assigned via SpoolBuddy
- # (the firmware drops ams_filament_setting on empty slots, so
- # MQTT was deferred). The moment any filament gets inserted
- # — Bambu RFID, 3rd-party, or even an existing-but-now-
- # reconfigured spool — fire the deferred configuration.
- # The "loaded" signal is state == 11 (Bambu's "filament fed to
- # extruder" code) OR, on firmwares that don't use the state
- # enum meaningfully, a non-empty tray_type when state is
- # NOT one of the firmware's explicit empty signals (9, 10).
- # state-only was wrong for firmwares that never set 11 — A1
- # Mini BMCU 01.07.02.00 and P1S Standard AMS 00.00.06.75 both
- # always report state=3 — so the replay never fired for them
- # (#1322). The state ∉ {9,10} guard keeps the firmware's
- # explicit "empty" signals authoritative over any stale
- # tray_type that might survive the relay's auto-clearing.
- loaded = cur_state == 11 or (cur_state not in (9, 10) and cur_type.strip())
- if not fp_type.strip() and loaded and assignment.spool:
- try:
- from backend.app.api.routes.inventory import (
- apply_spool_to_slot_via_mqtt,
- )
- await apply_spool_to_slot_via_mqtt(
- db=db,
- current_user=None,
- spool=assignment.spool,
- printer_id=printer_id,
- ams_id=assignment.ams_id,
- tray_id=assignment.tray_id,
- current_tray_info_idx=current_tray.get("tray_info_idx", ""),
- current_tray_type=cur_type,
- )
- logger.info(
- "SpoolBuddy pre-config applied on insert: spool %d → printer %d AMS%d-T%d",
- assignment.spool_id,
- printer_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- except Exception:
- logger.exception(
- "Pre-config apply failed for spool %d on printer %d AMS%d-T%d",
- assignment.spool_id,
- printer_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- assignment.fingerprint_color = cur_color
- assignment.fingerprint_type = cur_type
- continue
- if not _colors_similar(cur_color, fp_color) or cur_type.upper() != fp_type.upper():
- # Blank tray data mid-print is a runout, not a swap: the
- # firmware clears colour and type when it unloads a spool
- # it just emptied. Unlinking here would erase the record
- # of which spool fed the print so far.
- if printing_now and not cur_color.strip() and not cur_type.strip():
- logger.info(
- "Auto-unlink skipped: spool %d AMS%d-T%d — tray data cleared during a running print "
- "(runout?)",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- continue
- # Fingerprint mismatch — but check if tray now matches the
- # assigned spool (e.g. auto-configure changed the tray).
- # Both sides are reduced to the type the slot can carry
- # before comparing: the assign path writes that rather
- # than the spool's raw material (#2902), so a spool whose
- # material is a product line — "PLA+", "HTPLA" — reports
- # back as "PLA" and would otherwise fail this check and
- # be auto-unlinked from the slot it was just assigned to.
- # Reducing the printer's side too keeps slots configured
- # by an older Bambuddy, still reporting "PLA+", matching.
- spool = assignment.spool
- if spool:
- spool_color = (spool.rgba or "FFFFFFFF").upper()
- # Two ways the assign path can have arrived at the
- # slot's type, so both count as "we wrote this".
- # The material column is one; the spool's preset is
- # the other, and it outranks the material when the
- # spool has one -- a spool whose material says PLA
- # and whose preset is "Bambu PLA Aero" puts
- # PLA-AERO in the slot (#2902). Read from the stored
- # preset name rather than resolving the preset,
- # because this runs on every AMS push and a cloud
- # lookup here would be both slow and unavailable on
- # the unauthenticated replay path.
- spool_types = {printer_filament_type(spool.material).upper()}
- if spool.slicer_filament_name:
- spool_types.add(printer_filament_type(spool.slicer_filament_name).upper())
- # An imported local preset stores its type outright,
- # which is what the assign path used -- and the name
- # above may be unset. One keyed read, and only on a
- # mismatch, which is rare.
- #
- # slicer_filament is free text up to fifty characters,
- # so the digits have to be checked against the range
- # of the integer primary key they are about to be
- # compared with. Postgres raises on an out-of-range
- # integer rather than simply not matching, and that
- # would poison this session and abandon the rest of
- # the cleanup pass.
- lp_ref = (spool.slicer_filament or "").strip()
- if lp_ref.isdigit() and int(lp_ref) <= 2147483647:
- from backend.app.models.local_preset import LocalPreset as _LP
- lp_type = await db.scalar(select(_LP.filament_type).where(_LP.id == int(lp_ref)))
- if lp_type:
- spool_types.add(printer_filament_type(lp_type).upper())
- if (
- _colors_similar(cur_color, spool_color)
- and printer_filament_type(cur_type).upper() in spool_types
- ):
- logger.info(
- "Auto-unlink: spool %d AMS%d-T%d — fingerprint mismatch but tray matches spool, updating fp",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- )
- assignment.fingerprint_color = cur_color
- assignment.fingerprint_type = cur_type
- continue
- logger.info(
- "Auto-unlink: spool %d AMS%d-T%d — fingerprint mismatch (cur=%s/%s fp=%s/%s spool=%s/%s)",
- assignment.spool_id,
- assignment.ams_id,
- assignment.tray_id,
- cur_color,
- cur_type,
- fp_color,
- fp_type,
- spool.rgba if spool else "?",
- spool.material if spool else "?",
- )
- stale.append(assignment) # Spool changed
- # Snapshot slots before delete — ORM attribute access after the
- # commit would refresh against a deleted row.
- unlinked_slots = [(a.ams_id, a.tray_id) for a in stale]
- for a in stale:
- await db.delete(a)
- if stale:
- logger.info("Auto-unlinked %d stale spool assignments for printer %d", len(stale), printer_id)
- # Commit any changes (stale deletions and/or fingerprint updates)
- await db.commit()
- # Tell open browsers the assignment is gone (#2575). Only the manual
- # REST assign/unassign endpoints broadcast this event; without it the
- # frontend's spool-assignments cache keeps rendering the unlinked
- # spool on the slot until an unrelated refetch — which reads exactly
- # like "the fix didn't work" (reporter verified: a browser refresh
- # after the swap showed the correct state all along).
- for ams_id, tray_id in unlinked_slots:
- await ws_manager.broadcast(
- {
- "type": "spool_assignment_changed",
- "printer_id": printer_id,
- "ams_id": ams_id,
- "tray_id": tray_id,
- }
- )
- except Exception as e:
- logger.warning("Spool assignment cleanup failed: %s", e, exc_info=True)
- # Auto-manage inventory spools from AMS tray data (skip if Spoolman manages AMS).
- # Serialised per-printer via _ams_assignment_locks: MQTT bursts can deliver
- # two AMS pushes ~30 ms apart, and without the lock both callbacks read
- # "no existing assignment" for the same (printer, ams, tray) and race to
- # INSERT, hitting the spool_assignment_printer_id_ams_id_tray_id_key
- # unique constraint on Postgres. SQLite's WAL serialises writes so the
- # bug stayed latent there. See _ams_assignment_locks comment for details.
- try:
- async with _get_ams_assignment_lock(printer_id), async_session() as db:
- from backend.app.api.routes.settings import get_setting
- from backend.app.models.spool import Spool
- from backend.app.models.spool_assignment import SpoolAssignment as SA
- from backend.app.services.spool_tag_matcher import (
- auto_assign_spool,
- create_spool_from_tray,
- find_matching_untagged_spool,
- get_spool_by_tag,
- is_bambu_tag,
- is_valid_tag,
- link_tag_to_inventory_spool,
- )
- _spoolman_on = await get_setting(db, "spoolman_enabled")
- _auto_add_raw = await get_setting(db, "auto_add_unknown_rfid")
- _auto_add_unknown = _auto_add_raw is None or _auto_add_raw.lower() == "true"
- if not _spoolman_on or _spoolman_on.lower() != "true":
- for ams_unit in ams_data:
- if not isinstance(ams_unit, dict):
- continue
- ams_id = int(ams_unit.get("id", 0))
- for tray in ams_unit.get("tray", []):
- if not isinstance(tray, dict):
- continue
- tray_id = int(tray.get("id", 0))
- tag_uid = tray.get("tag_uid", "")
- tray_uuid = tray.get("tray_uuid", "")
- tray_info_idx = tray.get("tray_info_idx", "")
- if not tray.get("tray_type"):
- # Slot reported empty — drop any cached unknown-tag
- # broadcast so reinserting the same spool re-prompts.
- _clear_unknown_tag_dedup(printer_id, ams_id, tray_id)
- continue # Empty slot
- # Check if assignment already exists for this slot
- existing = await db.execute(
- select(SA)
- .options(selectinload(SA.spool).selectinload(Spool.k_profiles))
- .where(SA.printer_id == printer_id, SA.ams_id == ams_id, SA.tray_id == tray_id)
- )
- existing_assignment = existing.scalar_one_or_none()
- if existing_assignment:
- # Sync spool weight_used from AMS remain — only INCREASE, never decrease.
- # The AMS remain% is low-resolution (integer %, i.e. 10g steps for 1kg spool)
- # and must not overwrite precise values from the usage tracker (3MF/G-code).
- # Skip during active prints: the usage tracker handles deduction
- # precisely via 3MF data on print completion. Without this guard the
- # AMS remain% SET and the usage tracker ADD both fire from the same
- # MQTT message, doubling the deduction (#880).
- if _print_active:
- continue
- remain_raw = tray.get("remain")
- if (
- remain_raw is not None
- and existing_assignment.spool
- and not existing_assignment.spool.weight_locked
- ):
- try:
- remain_val = int(remain_raw)
- except (TypeError, ValueError):
- remain_val = -1
- if 1 <= remain_val <= 100:
- lw = existing_assignment.spool.label_weight or 1000
- new_used = round(lw * (100 - remain_val) / 100.0, 1)
- current_used = existing_assignment.spool.weight_used or 0
- if new_used > current_used + 1:
- logger.info(
- "Weight sync: spool %d weight_used %s -> %s (remain=%d)",
- existing_assignment.spool_id,
- current_used,
- new_used,
- remain_val,
- )
- existing_assignment.spool.weight_used = new_used
- await db.commit()
- # Re-apply stored K-profile when the live tray's
- # cali_idx drifted from the spool's stored profile.
- # This catches "reset slot → re-read" and any other
- # path where the firmware loses the user's K-profile
- # selection while the SpoolAssignment row persists.
- # Per the maintainer's rule: any time a spool tag is
- # identified and matches inventory, the slot must be
- # configured with the spool's stored settings. Without
- # this block the existing-assignment branch only ran
- # weight-sync and let the firmware-default cali_idx win.
- try:
- spool = existing_assignment.spool
- if (
- spool is not None
- and is_bambu_tag(tag_uid, tray_uuid, tray_info_idx)
- and spool.k_profiles
- ):
- state = printer_manager.get_status(printer_id)
- slot_nozzle = resolve_slot_nozzle(
- state, ams_id, tray_id, printer_manager.get_model(printer_id)
- )
- nozzle_diameter = slot_nozzle.diameter
- slot_extruder = slot_nozzle.extruder
- # Prefer exact extruder match, fall back to
- # extruder-agnostic kp for the same printer +
- # nozzle. Avoids hard-skipping when the AMS is
- # mapped differently than at calibration time.
- matching_kp = None
- fallback_kp = None
- for kp in spool.k_profiles:
- if (
- kp.printer_id != printer_id
- or kp.nozzle_diameter != nozzle_diameter
- or kp.cali_idx is None
- or not slot_nozzle.flow_matches(kp.nozzle_type)
- ):
- continue
- if (
- slot_extruder is not None
- and kp.extruder is not None
- and kp.extruder == slot_extruder
- ):
- matching_kp = kp
- break
- if fallback_kp is None:
- fallback_kp = kp
- chosen_kp = matching_kp or fallback_kp
- if chosen_kp is not None:
- live_cali_idx = tray.get("cali_idx")
- # Only fire MQTT when the printer's live
- # cali_idx differs from the stored value.
- # Avoids spamming the broker on every
- # MQTT push during steady-state operation.
- if live_cali_idx != chosen_kp.cali_idx:
- client = printer_manager.get_client(printer_id)
- if client:
- cali_filament_id = spool.slicer_filament or tray_info_idx or ""
- client.extrusion_cali_sel(
- ams_id=ams_id,
- tray_id=tray_id,
- cali_idx=chosen_kp.cali_idx,
- filament_id=cali_filament_id,
- nozzle_diameter=nozzle_diameter,
- )
- logger.info(
- "Re-applied K-profile cali_idx=%d for spool %d "
- "on printer %d AMS%d-T%d (live=%s drift detected)",
- chosen_kp.cali_idx,
- spool.id,
- printer_id,
- ams_id,
- tray_id,
- live_cali_idx,
- )
- except Exception:
- logger.exception(
- "K-profile re-apply failed for printer %d AMS%d-T%d",
- printer_id,
- ams_id,
- tray_id,
- )
- continue
- if is_bambu_tag(tag_uid, tray_uuid, tray_info_idx):
- # BL spool with RFID tag: auto-match → inventory match → auto-create
- spool = await get_spool_by_tag(db, tag_uid, tray_uuid)
- if not spool:
- # Try matching an untagged inventory spool (same material/color)
- spool = await find_matching_untagged_spool(db, tray)
- if spool:
- await link_tag_to_inventory_spool(db, spool, tray)
- elif _auto_add_unknown:
- spool = await create_spool_from_tray(db, tray)
- else:
- # Auto-add disabled: surface the slot so the
- # user can add it manually via the UI.
- await _broadcast_unknown_tag(
- printer_id=printer_id,
- ams_id=ams_id,
- tray_id=tray_id,
- tag_uid=tag_uid,
- tray_uuid=tray_uuid,
- tray_type=tray.get("tray_type"),
- tray_color=tray.get("tray_color"),
- tray_sub_brands=tray.get("tray_sub_brands"),
- tray_count=len(ams_unit.get("tray", [])),
- )
- continue
- # Slot matched (existing tag, untagged inventory
- # match, or freshly auto-created spool) — drop any
- # stale dedup so a future tag swap re-prompts.
- _clear_unknown_tag_dedup(printer_id, ams_id, tray_id)
- await auto_assign_spool(
- printer_id,
- ams_id,
- tray_id,
- spool,
- printer_manager,
- db,
- tray_info_idx=tray_info_idx,
- )
- await db.commit()
- await ws_manager.broadcast(
- {
- "type": "spool_auto_assigned",
- "printer_id": printer_id,
- "ams_id": ams_id,
- "tray_id": tray_id,
- "spool_id": spool.id,
- }
- )
- logger.info(
- "RFID auto-assigned spool %d to printer %d AMS%d-T%d",
- spool.id,
- printer_id,
- ams_id,
- tray_id,
- )
- elif is_valid_tag(tag_uid, tray_uuid):
- # Non-BL spool with some tag — let user choose
- await _broadcast_unknown_tag(
- printer_id=printer_id,
- ams_id=ams_id,
- tray_id=tray_id,
- tag_uid=tag_uid,
- tray_uuid=tray_uuid,
- tray_type=tray.get("tray_type"),
- tray_color=tray.get("tray_color"),
- tray_sub_brands=tray.get("tray_sub_brands"),
- tray_count=len(ams_unit.get("tray", [])),
- )
- # No-tag slots (generic non-RFID filament) are left alone:
- # nothing to identify, prompting "+ Add" would just create
- # ghost spools with empty tags on every confirm.
- except Exception as e:
- logger.warning("RFID spool auto-assign failed: %s", e, exc_info=True)
- try:
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- from backend.app.models.printer import Printer
- # Check if Spoolman is enabled
- spoolman_enabled = await get_setting(db, "spoolman_enabled")
- if not spoolman_enabled or spoolman_enabled.lower() != "true":
- return
- # Check sync mode
- sync_mode = await get_setting(db, "spoolman_sync_mode")
- if sync_mode and sync_mode != "auto":
- return # Only sync on auto mode
- _auto_add_raw_sm = await get_setting(db, "auto_add_unknown_rfid")
- auto_add_unknown_rfid = _auto_add_raw_sm is None or _auto_add_raw_sm.lower() == "true"
- # `spoolman_disable_weight_sync` is deprecated (#1119) — weight is now
- # always owned by per-print tracking, never by AMS auto-sync. The
- # setting is still read by the settings UI for backwards compat but
- # has no effect on the sync path here.
- # Get Spoolman URL
- spoolman_url = await get_setting(db, "spoolman_url")
- if not spoolman_url:
- return
- # Get or create Spoolman client
- client = await get_spoolman_client()
- if not client:
- try:
- client = await init_spoolman_client(spoolman_url)
- except ValueError as exc:
- logger.warning("Spoolman URL %r rejected by SSRF guard: %s", spoolman_url, exc)
- return
- # Check if Spoolman is reachable
- if not await client.health_check():
- logger.warning("Spoolman not reachable at %s", spoolman_url)
- return
- # Get printer name for location
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- printer_name = printer.name if printer else f"Printer {printer_id}"
- # OPTIMIZATION: Fetch all spools once before processing trays
- # This eliminates redundant API calls (one per tray) when syncing multiple trays
- logger.debug("[Printer %s] Fetching spools cache for AMS sync...", printer_id)
- try:
- cached_spools = await client.get_spools()
- logger.debug("[Printer %s] Cached %d spools for batch sync", printer_id, len(cached_spools))
- except Exception as e:
- logger.error(
- "[Printer %s] Failed to fetch spools cache after retries, aborting AMS sync: %s",
- printer_id,
- e,
- )
- return
- # Load inventory weights as fallback (when AMS MQTT data lacks remain values)
- from sqlalchemy.orm import selectinload
- from backend.app.models.spool_assignment import SpoolAssignment
- from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
- from backend.app.services.inventory_mode import spoolman_owns_assignments
- # Built-in remaining weight, used by sync_ams_tray only when the
- # firmware reports an unusable remain%/tray_weight for a slot.
- #
- # Left empty since #2812. This block runs in Spoolman mode only,
- # and until then the built-in table was emptied on the switch, so
- # there was never anything here to read and the fallback was inert.
- # Preserving those rows makes it live again, and it is keyed by slot
- # rather than by spool: after a mode switch the tray may well hold
- # different filament, and ``create_spool`` writes ``remaining_weight``
- # unconditionally, so a stale figure would be seeded into a brand new
- # Spoolman spool. Deliberately kept inert rather than deleted, so the
- # intent survives for whoever revisits the cross-mode fallback.
- inventory_weights: dict[tuple[int, int], float] = {}
- if not await spoolman_owns_assignments(db):
- try:
- assign_result = await db.execute(
- select(SpoolAssignment)
- .options(selectinload(SpoolAssignment.spool))
- .where(SpoolAssignment.printer_id == printer_id)
- )
- for assignment in assign_result.scalars().all():
- spool = assignment.spool
- if spool and spool.label_weight > 0:
- remaining = max(0.0, spool.label_weight - (spool.weight_used or 0))
- inventory_weights[(assignment.ams_id, assignment.tray_id)] = remaining
- except Exception as e:
- logger.warning("Could not load inventory weights for printer %s: %s", printer_id, e)
- # Load existing Spoolman slot assignments for the no-RFID fallback path
- spoolman_slot_map: dict[tuple[int, int], int] = {}
- try:
- slot_result = await db.execute(
- select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer_id)
- )
- for slot in slot_result.scalars().all():
- spoolman_slot_map[(slot.ams_id, slot.tray_id)] = slot.spoolman_spool_id
- except Exception as e:
- logger.warning("Could not load Spoolman slot assignments for printer %s: %s", printer_id, e)
- # Sync each AMS tray and collect slot changes for DB persistence
- synced = 0
- slot_changes: list[tuple[int, int, int]] = [] # (ams_id, tray_id, spoolman_spool_id) to upsert
- empty_slots: list[tuple[int, int]] = [] # (ams_id, tray_id) whose tray is now empty
- for ams_unit in ams_data:
- if not isinstance(ams_unit, dict):
- continue
- ams_id = int(ams_unit.get("id", 0))
- trays = ams_unit.get("tray", [])
- for tray_data in trays:
- if not isinstance(tray_data, dict):
- continue
- tray_id_raw = int(tray_data.get("id", 0))
- tray = client.parse_ams_tray(ams_id, tray_data)
- if not tray:
- # Empty tray slot — record for local assignment cleanup
- # and drop any cached unknown-tag broadcast so a
- # reinserted spool re-prompts.
- #
- # Not during a running print: a slot that empties there
- # is a filament runout, and the spool is still in the
- # AMS. `spoolman_slot_assignments` is how a tag-less
- # spool assigned through the Bambuddy UI is resolved at
- # completion (#1459), so deleting the row mid-print
- # loses the runout segment's usage — the same failure
- # the internal inventory's auto-unlink had.
- if not printing_now:
- empty_slots.append((ams_id, tray_id_raw))
- _clear_unknown_tag_dedup(printer_id, ams_id, tray_id_raw)
- continue
- spool_tag = (
- tray.tray_uuid
- if tray.tray_uuid and tray.tray_uuid != "00000000000000000000000000000000"
- else tray.tag_uid
- )
- # Provide the hint only when no RFID is available
- hint = spoolman_slot_map.get((ams_id, tray.tray_id)) if not spool_tag else None
- try:
- inv_remaining = inventory_weights.get((ams_id, tray.tray_id))
- result = await client.sync_ams_tray(
- tray,
- printer_name,
- # Per-print tracking is the only weight writer (#1119).
- # AMS auto-sync still maintains spool metadata / slot
- # assignments but no longer touches remaining_weight.
- disable_weight_sync=True,
- cached_spools=cached_spools,
- inventory_remaining=inv_remaining,
- spoolman_spool_id_hint=hint,
- auto_add_unknown_rfid=auto_add_unknown_rfid,
- )
- if result is None and spool_tag and not auto_add_unknown_rfid:
- # Spoolman skipped auto-create per user setting — surface
- # the slot so the UI can offer "+ Add to inventory".
- await _broadcast_unknown_tag(
- printer_id=printer_id,
- ams_id=ams_id,
- tray_id=tray.tray_id,
- tag_uid=tray.tag_uid or "",
- tray_uuid=tray.tray_uuid or "",
- tray_type=tray.tray_type,
- tray_color=tray.tray_color,
- tray_sub_brands=tray.tray_sub_brands,
- tray_count=len(trays),
- )
- elif result:
- _clear_unknown_tag_dedup(printer_id, ams_id, tray.tray_id)
- if result:
- synced += 1
- if result.get("id"):
- slot_changes.append((ams_id, tray.tray_id, result["id"]))
- # If a new spool was created, add it to the cache
- # so subsequent trays can find it if they reference the same tag
- spool_exists = any(s.get("id") == result["id"] for s in cached_spools)
- if not spool_exists:
- cached_spools.append(result)
- logger.debug(
- "[Printer %s] Added newly created spool %s to cache",
- printer_id,
- result["id"],
- )
- # Reconcile slot_preset_mappings (the same row internal
- # mode keeps in sync via inventory + spool_tag_matcher).
- # Without this the slot card surfaces the previous spool's
- # preset name — same bug shape, different inventory mode.
- from backend.app.services.slot_preset_writer import (
- upsert_slot_preset_for_spoolman_spool,
- )
- await upsert_slot_preset_for_spoolman_spool(
- db=db,
- spoolman_spool=result,
- tray_info_idx=tray.tray_info_idx or "",
- tray_sub_brands=tray.tray_sub_brands or "",
- tray_type=tray.tray_type or "",
- printer_id=printer_id,
- ams_id=ams_id,
- tray_id=tray.tray_id,
- )
- except Exception as e:
- logger.error("Error syncing AMS %s tray %s: %s", ams_id, tray.tray_id, e)
- if synced > 0:
- logger.info("Auto-synced %s AMS trays to Spoolman for printer %s", synced, printer_id)
- # Persist slot assignment changes to the local table
- if slot_changes or empty_slots:
- try:
- for ams_id, tray_id, spool_id in slot_changes:
- await db.execute(
- text(
- "INSERT INTO spoolman_slot_assignments"
- " (printer_id, ams_id, tray_id, spoolman_spool_id)"
- " VALUES (:printer_id, :ams_id, :tray_id, :spool_id)"
- " ON CONFLICT(printer_id, ams_id, tray_id)"
- " DO UPDATE SET spoolman_spool_id = excluded.spoolman_spool_id"
- ),
- {
- "printer_id": printer_id,
- "ams_id": ams_id,
- "tray_id": tray_id,
- "spool_id": spool_id,
- },
- )
- for ams_id, tray_id in empty_slots:
- await db.execute(
- delete(SpoolmanSlotAssignment).where(
- SpoolmanSlotAssignment.printer_id == printer_id,
- SpoolmanSlotAssignment.ams_id == ams_id,
- SpoolmanSlotAssignment.tray_id == tray_id,
- )
- )
- await db.commit()
- except Exception as e:
- await db.rollback()
- logger.error("Error persisting Spoolman slot assignments for printer %s: %s", printer_id, e)
- else:
- # Tell open browsers the slot changed. This loop rewrites
- # slot_preset_mappings via upsert_slot_preset_for_spoolman_spool
- # above, and the AMS slot card reads that row ahead of the
- # live tray_info_idx -- so with no event the card keeps
- # showing the previous spool's preset name. Internal mode
- # raises spool_auto_assigned for the same reason; this loop
- # broadcast nothing at all, which made Spoolman mode the
- # worse half of the same bug. On the else branch so a
- # failed commit stays silent and a broadcast failure cannot
- # roll back rows that are already committed.
- for ams_id, tray_id, *_ in (*slot_changes, *empty_slots):
- await ws_manager.broadcast(
- {
- "type": "spool_assignment_changed",
- "printer_id": printer_id,
- "ams_id": ams_id,
- "tray_id": tray_id,
- }
- )
- except Exception as e:
- logging.getLogger(__name__).error("Spoolman AMS sync failed for printer %s: %s", printer_id, e)
- async def _capture_snapshot_for_notification(printer_id: int, printer, logger) -> bytes | None:
- """Capture a camera snapshot for notification image attachment.
- Returns JPEG bytes (max 2.5MB) or None if capture fails or is unavailable.
- Uses: external camera > buffered frame > fresh capture.
- """
- if not printer:
- return None
- try:
- from backend.app.api.routes.settings import get_setting
- async with async_session() as db:
- capture_enabled = await get_setting(db, "capture_finish_photo")
- if capture_enabled is not None and capture_enabled.lower() != "true":
- return None
- # Try external camera first
- if printer.external_camera_enabled and printer.external_camera_url:
- logger.info("[SNAPSHOT] Capturing from external camera for printer %s", printer_id)
- from backend.app.api.routes.camera import live_frame_for_capture
- from backend.app.services.external_camera import capture_frame
- # An external camera allows one reader, so capturing while a viewer
- # is attached fails (#2707). A None here falls through to the paths
- # below exactly as a failed capture did.
- defer, buffered = live_frame_for_capture(printer_id)
- if defer:
- frame_data = buffered
- else:
- frame_data = await capture_frame(
- printer.external_camera_url,
- printer.external_camera_type or "mjpeg",
- snapshot_url=printer.external_camera_snapshot_url,
- )
- if frame_data and len(frame_data) <= 2_500_000:
- logger.info("[SNAPSHOT] External camera frame: %s bytes", len(frame_data))
- return _apply_camera_rotation(frame_data, printer, logger)
- # Try buffered frame from active stream
- from backend.app.api.routes.camera import _active_chamber_streams, _active_streams, get_buffered_frame
- active_for_printer = [k for k in _active_streams if k.startswith(f"{printer_id}-")]
- active_chamber = [k for k in _active_chamber_streams if k.startswith(f"{printer_id}-")]
- buffered_frame = get_buffered_frame(printer_id)
- if (active_for_printer or active_chamber) and buffered_frame:
- logger.info("[SNAPSHOT] Using buffered frame for printer %s: %s bytes", printer_id, len(buffered_frame))
- if len(buffered_frame) <= 2_500_000:
- return _apply_camera_rotation(buffered_frame, printer, logger)
- # Fresh capture from printer camera
- logger.info("[SNAPSHOT] Capturing fresh frame for printer %s", printer_id)
- from backend.app.services.camera import capture_camera_frame_bytes
- frame_data = await capture_camera_frame_bytes(
- printer.ip_address, printer.access_code, printer.model, timeout=15
- )
- if frame_data and len(frame_data) <= 2_500_000:
- logger.info("[SNAPSHOT] Fresh camera frame: %s bytes", len(frame_data))
- return _apply_camera_rotation(frame_data, printer, logger)
- except Exception as e:
- logger.warning("[SNAPSHOT] Failed to capture snapshot for printer %s: %s", printer_id, e)
- return None
- async def _maybe_bank_inprint_frame(printer_id: int, layer_num: int) -> None:
- """#1867: bank a recent in-print camera frame for the finish photo.
- Called on every layer change and (#2547) on every print-progress advance.
- Grabs one frame (throttled) into ``_inprint_frame_bank`` so the finish-photo
- path has a pre-End-G-code image for prints that end with a plate swap.
- Both drivers are print telemetry that stops the instant printing ends: no
- further layers, and progress freezes before the End G-code (e.g. SwapMod
- plate swap) executes. So the last banked frame is always the finished print,
- never the swapped plate — that property is what the #1867 path relies on and
- it must survive any change to the throttle below.
- Layer changes alone were not enough: they stop when the *final* layer
- begins, which on a three-minute last layer left the bank stale by the whole
- length of that layer (#2547). Progress keeps ticking through it.
- Best-effort: any failure just leaves the previous banked frame.
- """
- logger = logging.getLogger(__name__)
- client = printer_manager.get_client(printer_id)
- state = client.state if client else None
- if not state or state.state != "RUNNING":
- return
- # Only during actual extrusion — firmware ticks layer_num during the
- # pre-print calibration sequence, whose sub-stages are non-zero.
- if state.mc_print_sub_stage not in (None, 0):
- return
- # #2547: throttled uniformly, with no last-layer exemption. The old code
- # bypassed the throttle on the final layer to guarantee a fresh frame there;
- # now that progress advances also drive banking, that exemption would fire a
- # camera grab on every percent tick of the last layer. Bambu printers accept
- # one RTSP client at a time, so each grab contends with the live view.
- now = time.monotonic()
- last = _inprint_frame_bank_ts.get(printer_id, 0.0)
- if (now - last) < _INPRINT_BANK_MIN_INTERVAL:
- return
- total = state.total_layers or 0
- try:
- async with async_session() as db:
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if not printer:
- return
- # Reuses the notification snapshot path, which honours the
- # `capture_finish_photo` setting (returns None when disabled) so we
- # don't bank frames the user never asked for.
- frame = await _capture_snapshot_for_notification(printer_id, printer, logger)
- if frame:
- _inprint_frame_bank[printer_id] = frame
- _inprint_frame_bank_ts[printer_id] = now
- logger.debug(
- "[FINISH-PHOTO-BANK] banked in-print frame for printer %s at layer %s/%s (%d bytes)",
- printer_id,
- layer_num,
- total,
- len(frame),
- )
- except Exception as e:
- logger.debug("[FINISH-PHOTO-BANK] bank failed for printer %s: %s", printer_id, e)
- def _apply_camera_rotation(image_data: bytes, printer, logger) -> bytes:
- """Apply camera rotation to snapshot image if configured."""
- from backend.app.services.camera import apply_camera_rotation
- return apply_camera_rotation(image_data, getattr(printer, "camera_rotation", 0), logger)
- async def _send_print_start_notification(
- printer_id: int,
- data: dict,
- archive_data: dict | None = None,
- logger=None,
- ):
- """Helper to send print start notification with optional archive data."""
- if logger is None:
- logger = logging.getLogger(__name__)
- try:
- async with async_session() as db:
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- printer_name = printer.name if printer else f"Printer {printer_id}"
- # Capture camera snapshot for notification image attachment
- image_data = await _capture_snapshot_for_notification(printer_id, printer, logger)
- if image_data:
- if archive_data is None:
- archive_data = {}
- archive_data["image_data"] = image_data
- await notification_service.on_print_start(printer_id, printer_name, data, db, archive_data=archive_data)
- # Send user-specific email notification for print start
- if archive_data and archive_data.get("created_by_id"):
- await notification_service.send_user_print_email(
- event_type="user_print_start",
- created_by_id=archive_data["created_by_id"],
- printer_name=printer_name,
- filename=data.get("subtask_name") or data.get("filename", "Unknown"),
- db=db,
- )
- except Exception as e:
- logger.warning("Notification on_print_start failed: %s", e)
- async def _dispatch_user_print_email(
- status: str,
- created_by_id: int | None,
- printer_name: str,
- filename: str,
- db,
- ) -> None:
- """Send a user-specific print-completion email based on print status.
- Maps the normalised print status to the correct event type and delegates
- to :meth:`NotificationService.send_user_print_email`. A single helper
- avoids duplicating the ``if status == "completed" / elif "failed" / elif
- "stopped"`` dispatch block at every call site.
- Does nothing if *created_by_id* is ``None``.
- """
- if created_by_id is None:
- return
- if status == "completed":
- event_type = "user_print_complete"
- elif status == "failed":
- event_type = "user_print_failed"
- elif status in ("stopped", "aborted", "cancelled"):
- event_type = "user_print_stopped"
- else:
- return
- await notification_service.send_user_print_email(
- event_type=event_type,
- created_by_id=created_by_id,
- printer_name=printer_name,
- filename=filename,
- db=db,
- )
- def _load_objects_from_archive(archive, printer_id: int, logger) -> None:
- """Extract printable objects from an archive's 3MF file and store in printer state."""
- try:
- from backend.app.services.archive import extract_printable_objects_from_archive
- client = printer_manager.get_client(printer_id)
- if not client:
- return
- # Extract with positions for UI overlay, scoped to the plate that
- # is printing — resolve_plate_id is the same resolver /cover uses,
- # so the object list can't disagree with the thumbnail it is drawn
- # over (#2522).
- printable_objects, bbox_all = extract_printable_objects_from_archive(
- app_settings.base_dir / archive.file_path,
- plate_number=resolve_plate_id(client.state),
- )
- if printable_objects:
- client.state.printable_objects = printable_objects
- client.state.printable_objects_bbox_all = bbox_all
- client.state.skipped_objects = []
- logger.info("Loaded %s printable objects for printer %s", len(printable_objects), printer_id)
- except Exception as e:
- logger.debug("Failed to extract printable objects from archive: %s", e)
- async def _restore_printable_objects(printer_id: int, state, db, logger) -> None:
- """Put the skip-objects list back after a restart mid-print.
- ``PrinterState.printable_objects`` is in-memory only, and the only thing
- that fills it is ``_load_objects_from_archive`` on the print-start paths —
- which the #1304 guard suppresses on the first RUNNING push after startup.
- Everything else this hook restores (the archive, the usage-tracking session,
- the timelapse baseline) was already handled; the object list was not, so a
- restart mid-print took skip-objects away for the rest of that print.
- Nothing recovered it either: the printer card gates its Skip button on the
- object count, and the one endpoint that can rebuild the list is reachable
- only from the modal that button opens.
- Anchored on ``subtask_id``, which the firmware mints per print, so a
- leftover ``status="printing"`` row from a completion we never saw cannot
- hand this print someone else's objects. Without one, nothing is loaded
- rather than guessed — the reload path on ``GET /print/objects`` covers that
- case on demand.
- """
- client = printer_manager.get_client(printer_id)
- if client is None or client.state.printable_objects:
- return
- subtask_id = str(getattr(state, "subtask_id", "") or "").strip()
- if subtask_id in ("", "0"):
- return
- from backend.app.models.archive import PrintArchive
- archive = await db.scalar(
- select(PrintArchive)
- .where(
- PrintArchive.printer_id == printer_id,
- PrintArchive.status == "printing",
- PrintArchive.subtask_id == subtask_id,
- )
- .order_by(PrintArchive.created_at.desc())
- .limit(1)
- )
- if archive is not None:
- _load_objects_from_archive(archive, printer_id, logger)
- # Retry ladder for a fallback archive created while the printer's FTPS cool-off
- # was running (#2957). The cool-off is 300s, so the first attempt is placed just
- # past it; the second covers a handshake that failed again on the way back and
- # armed a fresh one. Module-level so tests can shrink them.
- _FALLBACK_3MF_RETRY_DELAYS_SECONDS: tuple[float, ...] = (310.0, 620.0)
- # printer_id -> the in-flight retry task, so print completion can cancel it.
- _fallback_3mf_retry_tasks: dict[int, asyncio.Task] = {}
- # printer_id -> lock serialising recovery attempts for that printer. Three callers
- # can reach one archive at once: the cover endpoint (whose single-flight coalesces
- # by view, so two views race), the cool-off retry task, and print completion.
- # Without this they each read file_path == "" and each run a full copy, so the row
- # ends up pointing at one timestamped directory while the others sit orphaned.
- #
- # Keyed by printer rather than archive because a printer runs one print at a time,
- # which makes the two equally strong here — and it bounds the dict by printer
- # count instead of needing a cleanup pass. Popping a per-archive entry cannot be
- # done safely: `Lock.locked()` reads False between release and the queued waiter
- # resuming, so "no waiters" is not a question this API can answer.
- _fallback_recovery_locks: dict[int, asyncio.Lock] = {}
- async def _recover_fallback_archive(archive_id: int, source_3mf: Path, printer_id: int) -> bool:
- """Fill in a no-3MF archive from a 3MF that turned up later.
- Returns True when the row was upgraded. Safe to call speculatively: it
- verifies the archive still exists, is still a fallback, and that the file
- is a readable 3MF before touching anything.
- Serialised per printer — see ``_fallback_recovery_locks``.
- """
- lock = _fallback_recovery_locks.setdefault(printer_id, asyncio.Lock())
- async with lock:
- return await _recover_fallback_archive_locked(archive_id, source_3mf, printer_id)
- async def _recover_fallback_archive_locked(archive_id: int, source_3mf: Path, printer_id: int) -> bool:
- """The body of :func:`_recover_fallback_archive`, under its per-printer lock."""
- import zipfile
- from backend.app.models.archive import PrintArchive
- from backend.app.services.archive import ArchiveService
- logger = logging.getLogger(__name__)
- if not source_3mf.exists() or source_3mf.stat().st_size == 0:
- return False
- if not await asyncio.to_thread(zipfile.is_zipfile, source_3mf):
- # A truncated or half-written download is worse than no download: it
- # would replace an honest empty archive with wrong metadata.
- logger.warning("[RECOVER] %s is not a readable 3MF; leaving archive %s as-is", source_3mf, archive_id)
- return False
- async with async_session() as db:
- archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
- if archive is None or archive.deleted_at is not None:
- return False
- if archive.file_path:
- # Already recovered, or never was a fallback. Either way there is a
- # real 3MF attached and overwriting it is not this function's job.
- return False
- print_data = (archive.extra_data or {}).get("_print_data") or {}
- service = ArchiveService(db)
- recovered = await service.archive_print(
- printer_id=printer_id,
- source_file=source_3mf,
- print_data={**print_data, "status": archive.status or "printing"},
- subtask_id=archive.subtask_id,
- update_archive_id=archive.id,
- )
- if recovered is None:
- return False
- logger.info(
- "[RECOVER] Archive %s filled in from %s (%s bytes) — it started as a no-3MF fallback",
- archive_id,
- source_3mf,
- recovered.file_size,
- )
- # `archive_updated`, not `archive_created` — the row was already on the
- # Archives page as an empty card and is now filled in, not new.
- await ws_manager.send_archive_updated(
- {
- "id": recovered.id,
- "printer_id": recovered.printer_id,
- "filename": recovered.filename,
- "print_name": recovered.print_name,
- "status": recovered.status,
- }
- )
- return True
- async def try_recover_fallback_archive(printer_id: int, name: str, path: Path) -> bool:
- """Offer a freshly-downloaded 3MF to this printer's running fallback archive.
- Called from the paths that pull a 3MF for a print that is already under way
- — chiefly the cover endpoint, which downloads the very file the archive flow
- could not get and, before #2957, used it for a thumbnail and nothing else.
- The bytes are already local, so this costs a parse and a row update.
- No-op when the running print has a real archive, which is the common case.
- """
- from backend.app.models.archive import PrintArchive
- logger = logging.getLogger(__name__)
- # `_active_prints` is keyed on the raw names seen at print start — the
- # dispatch filename, the subtask name, and the subtask name plus ".3mf".
- # Callers here arrive with whichever variant their own path produced, so
- # match on the same normalization the download cache uses rather than on an
- # exact string; that is what makes "Desktop_Goose.gcode.3mf" from the cover
- # endpoint find an archive registered under "Desktop_Goose".
- wanted = normalize_3mf_name(name)
- archive_id = None
- for (key_printer_id, key_name), value in list(_active_prints.items()):
- if key_printer_id == printer_id and normalize_3mf_name(key_name) == wanted:
- archive_id = value
- break
- if archive_id is None:
- return False
- async with async_session() as db:
- archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
- # Cheap pre-check so the common case (a normal archive) does no work.
- if archive is None or archive.file_path or archive.deleted_at is not None:
- return False
- try:
- return await _recover_fallback_archive(archive_id, path, printer_id)
- except Exception as e:
- # Recovery is opportunistic. A failure here must never take down the
- # caller, which is usually just trying to render a thumbnail.
- logger.warning("[RECOVER] Could not fill in archive %s from %s: %s", archive_id, path, e)
- return False
- def _schedule_fallback_3mf_retry(printer_id: int, archive_id: int, filenames: list[str]) -> None:
- """Re-attempt the 3MF download after the printer's FTPS cool-off clears."""
- logger = logging.getLogger(__name__)
- async def _retry() -> None:
- from backend.app.models.archive import PrintArchive
- from backend.app.models.printer import Printer
- for delay in _FALLBACK_3MF_RETRY_DELAYS_SECONDS:
- await asyncio.sleep(delay)
- async with async_session() as db:
- archive = (
- await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
- ).scalar_one_or_none()
- if archive is None or archive.deleted_at is not None or archive.file_path:
- return
- printer = (await db.execute(select(Printer).where(Printer.id == printer_id))).scalar_one_or_none()
- if printer is None:
- return
- # Read the fields while the session is open rather than touching
- # a detached instance minutes later, mid-download.
- printer_ip = printer.ip_address
- printer_code = printer.access_code
- printer_model = printer.model
- # Someone else may have fetched it in the meantime — the cover
- # endpoint routinely does, and its copy is the same bytes.
- for name in filenames:
- cached = get_cached_3mf(printer_id, name)
- if cached and await _recover_fallback_archive(archive_id, cached, printer_id):
- return
- if ftps_handshake_blocked(printer_ip):
- logger.info(
- "[RECOVER] Printer %s is still in its FTPS cool-off; archive %s retry deferred",
- printer_id,
- archive_id,
- )
- continue
- _, _, _, ftp_timeout = await get_ftp_retry_settings()
- for candidate in filenames:
- # Bare name only. These come from the print-start flow, which
- # already strips the path, but the local temp write must not
- # depend on that holding for every future caller — a name that
- # is absolute or contains ".." would otherwise escape the data
- # volume via the `/` operator.
- name = Path(candidate).name
- if not name or name in (".", ".."):
- continue
- if not name.endswith(".3mf"):
- name = f"{name}.3mf"
- temp_path = app_settings.archive_dir / "temp" / name
- temp_path.parent.mkdir(parents=True, exist_ok=True)
- try:
- hit = await download_file_try_paths_async(
- printer_ip,
- printer_code,
- ftp_probe_paths(name),
- temp_path,
- socket_timeout=ftp_timeout,
- printer_model=printer_model,
- )
- except Exception as e:
- logger.debug("[RECOVER] Retry download of %s failed: %s", name, e)
- continue
- if not hit:
- continue
- cache_3mf_download(printer_id, name, temp_path)
- if await _recover_fallback_archive(archive_id, temp_path, printer_id):
- return
- logger.info("[RECOVER] Archive %s still has no 3MF after a retry", archive_id)
- async def _guarded() -> None:
- try:
- await _retry()
- except asyncio.CancelledError:
- raise
- except Exception as e:
- logger.warning("[RECOVER] Retry task for archive %s failed: %s", archive_id, e)
- finally:
- if _fallback_3mf_retry_tasks.get(printer_id) is asyncio.current_task():
- _fallback_3mf_retry_tasks.pop(printer_id, None)
- existing = _fallback_3mf_retry_tasks.pop(printer_id, None)
- if existing and not existing.done():
- existing.cancel()
- task = asyncio.create_task(_guarded())
- _fallback_3mf_retry_tasks[printer_id] = task
- logger.info(
- "[RECOVER] Archive %s has no 3MF because printer %s was in its FTPS cool-off; will retry",
- archive_id,
- printer_id,
- )
- async def on_print_start(printer_id: int, data: dict):
- """Handle print start - archive the 3MF file immediately."""
- logger = logging.getLogger(__name__)
- logger.info("[CALLBACK] on_print_start called for printer %s, data keys: %s", printer_id, list(data.keys()))
- # Clear any stale user-stopped flag from previous print cycles
- _user_stopped_printers.discard(printer_id)
- _kill_switch_notification_tasks.pop(printer_id, None)
- # #1721: drop any leftover pre-captured finish frame from a prior print
- # so a never-consumed cache entry can't bleed into the new print's photo.
- _stage22_finish_frames.pop(printer_id, None)
- # #1867: same for the in-print frame bank — a queued print must not reuse
- # the previous job's banked frame.
- _inprint_frame_bank.pop(printer_id, None)
- _inprint_frame_bank_ts.pop(printer_id, None)
- # #2547: bind (or clear) the "this print ends with injected End G-code" flag.
- # Unconditional, so a print Bambuddy didn't dispatch drops the previous
- # print's flag instead of inheriting it.
- print_dispatch_context.adopt(printer_id)
- # Cancel any active bed cooldown waiter for this printer
- if _bed_cool_waiters.pop(printer_id, None):
- logger.info("[BED-COOL] Cancelled bed cooldown waiter for printer %s (new print started)", printer_id)
- # Clear cached cover images so the new print's thumbnail is fetched fresh
- from backend.app.api.routes.printers import clear_cover_cache
- clear_cover_cache(printer_id)
- await ws_manager.send_print_start(printer_id, data)
- # Notify when the print-start AMS mapping references tray slots without spool assignments.
- await notify_missing_spool_assignments_on_print_start(printer_id, data, logger)
- # MQTT relay - publish print start
- try:
- printer_info = printer_manager.get_printer(printer_id)
- if printer_info:
- await mqtt_relay.on_print_start(
- printer_id,
- printer_info.name,
- printer_info.serial_number,
- data.get("filename", ""),
- data.get("subtask_name", ""),
- )
- except Exception:
- pass # Don't fail print start callback if MQTT fails
- # Capture AMS tray remain%, the assignment snapshot, the dispatched plate
- # and mapping, and the seeded tray-change log.
- #
- # Unconditional, for both inventory backends. This only *captures* — the
- # writing is still split, with the internal tracker skipped at completion
- # when Spoolman owns usage. Spoolman's own durable row (#1820) already
- # carries its plate-scoped 3MF figures and stored mapping, but not the
- # tray-change log, and that log is the only record of which spool fed
- # which layers when AMS Filament Backup swaps trays mid-print. Capturing
- # it on one side only would leave Spoolman users with the mid-print
- # restart bug this fixes for everyone else.
- try:
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- from backend.app.services.usage_tracker import on_print_start as usage_on_print_start
- _spoolman_on = await get_setting(db, "spoolman_enabled")
- await usage_on_print_start(
- printer_id,
- data,
- printer_manager,
- db=db,
- spoolman_owns_usage=bool(_spoolman_on) and _spoolman_on.lower() == "true",
- )
- except Exception as e:
- logger.warning("Usage tracker on_print_start failed: %s", e)
- # Track if notification was sent (to avoid sending twice)
- notification_sent = False
- # Smart plug automation: turn on plug when print starts
- try:
- async with async_session() as db:
- await smart_plug_manager.on_print_start(printer_id, db)
- except Exception as e:
- logger.warning("Smart plug on_print_start failed: %s", e)
- async with async_session() as db:
- from backend.app.models.printer import Printer
- from backend.app.services.bambu_ftp import list_files_async
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- # Plate detection check - pause if objects detected on build plate
- logger.info(
- f"[PLATE CHECK] printer_id={printer_id}, plate_detection_enabled={printer.plate_detection_enabled if printer else 'NO PRINTER'}"
- )
- if printer and printer.plate_detection_enabled:
- logger.info("[PLATE CHECK] ENTERING plate detection code for printer %s", printer_id)
- # Release the pooled DB connection before the plate-detection camera
- # work (a 2.5s light-settle sleep + FTP/camera capture). Only the
- # printer SELECT has run so far — nothing to persist — so this commit
- # is a data-noop that ends the read transaction and returns the
- # connection to the pool during the I/O (issue #2572). expire_on_commit
- # =False keeps printer.* readable; on_plate_not_empty (rare) and the
- # archive lookups below re-acquire a fresh connection on next execute.
- await db.commit()
- try:
- from backend.app.services.plate_detection import check_plate_empty
- # Build ROI tuple from printer settings if available
- roi = None
- if all(
- [
- printer.plate_detection_roi_x is not None,
- printer.plate_detection_roi_y is not None,
- printer.plate_detection_roi_w is not None,
- printer.plate_detection_roi_h is not None,
- ]
- ):
- roi = (
- printer.plate_detection_roi_x,
- printer.plate_detection_roi_y,
- printer.plate_detection_roi_w,
- printer.plate_detection_roi_h,
- )
- # Auto-turn on chamber light if it's off for better detection
- light_was_off = False
- client = printer_manager.get_client(printer_id)
- if client and client.state:
- light_was_off = not client.state.chamber_light
- if light_was_off:
- logger.info("[PLATE CHECK] Turning on chamber light for printer %s", printer_id)
- client.set_chamber_light(True)
- # Wait for light to physically turn on and camera to adjust exposure
- await asyncio.sleep(2.5)
- logger.info("[PLATE CHECK] Running plate detection for printer %s", printer_id)
- plate_result = await check_plate_empty(
- printer_id=printer_id,
- ip_address=printer.ip_address,
- access_code=printer.access_code,
- model=printer.model,
- include_debug_image=False,
- external_camera_url=printer.external_camera_url,
- external_camera_type=printer.external_camera_type,
- use_external=printer.external_camera_enabled,
- roi=roi,
- external_camera_snapshot_url=printer.external_camera_snapshot_url,
- )
- # Restore chamber light to original state
- if light_was_off and client:
- logger.info("[PLATE CHECK] Restoring chamber light to off for printer %s", printer_id)
- client.set_chamber_light(False)
- if not plate_result.needs_calibration and not plate_result.is_empty:
- # Objects detected - pause the print!
- logger.warning(
- f"[PLATE CHECK] Objects detected on plate for printer {printer_id}! "
- f"Confidence: {plate_result.confidence:.0%}, Diff: {plate_result.difference_percent:.1f}%"
- )
- client = printer_manager.get_client(printer_id)
- if client:
- client.pause_print()
- logger.info("[PLATE CHECK] Print paused for printer %s", printer_id)
- # Send notification about plate not empty
- await ws_manager.broadcast(
- {
- "type": "plate_not_empty",
- "printer_id": printer_id,
- "printer_name": printer.name,
- "message": f"Objects detected on build plate! Print paused. (Diff: {plate_result.difference_percent:.1f}%)",
- }
- )
- # Also send push notification
- try:
- await notification_service.on_plate_not_empty(
- printer_id=printer_id,
- printer_name=printer.name,
- db=db,
- difference_percent=plate_result.difference_percent,
- )
- except Exception as notif_err:
- logger.warning("[PLATE CHECK] Failed to send notification: %s", notif_err)
- else:
- logger.info("[PLATE CHECK] Plate is empty for printer %s, proceeding with print", printer_id)
- except Exception as plate_err:
- # Don't block print on plate detection errors
- logger.warning("[PLATE CHECK] Plate detection failed for printer %s: %s", printer_id, plate_err)
- if not printer:
- logger.info("[CALLBACK] Skipping archive - printer not found in database")
- if not notification_sent:
- await _send_print_start_notification(printer_id, data, logger=logger)
- return
- if not printer.auto_archive:
- # auto-archive disabled — check if there's an expected print (dispatched
- # by BamBuddy via queue/reprint) that already has an archive to promote.
- # If so, fall through to the expected-print handling below so the archive
- # is tracked in _active_prints and usage tracking works at completion.
- _fn = data.get("filename", "")
- _sn = data.get("subtask_name", "")
- _check_keys: list[tuple[int, str]] = []
- if _sn:
- _check_keys += [
- (printer_id, _sn),
- (printer_id, f"{_sn}.3mf"),
- (printer_id, f"{_sn}.gcode.3mf"),
- ]
- if _fn:
- _base_fn = _fn.split("/")[-1] if "/" in _fn else _fn
- _check_keys.append((printer_id, _base_fn))
- _no_archive_base = _base_fn.replace(".gcode", "").replace(".3mf", "")
- _check_keys += [
- (printer_id, _no_archive_base),
- (printer_id, f"{_no_archive_base}.3mf"),
- ]
- _has_expected = any(k in _expected_prints for k in _check_keys)
- if not _has_expected:
- # No expected print — truly external print (started from slicer/touchscreen)
- logger.info("[CALLBACK] Skipping archive - auto_archive: False, no expected print")
- if not notification_sent:
- _no_archive_creator: int | None = None
- for _key in _check_keys:
- _expected_prints.pop(_key, None)
- _expected_print_registered_at.pop(_key, None)
- popped_creator = _expected_print_creators.pop(_key, None)
- if _no_archive_creator is None:
- _no_archive_creator = popped_creator
- _creator_data = {"created_by_id": _no_archive_creator} if _no_archive_creator else None
- await _send_print_start_notification(printer_id, data, _creator_data, logger)
- return
- else:
- logger.info("[CALLBACK] auto_archive disabled but expected print found — promoting archive")
- # Get the filename and subtask_name
- filename = data.get("filename", "")
- subtask_name = data.get("subtask_name", "")
- # MQTT subtask_id uniquely identifies a print job on the printer. When
- # present, it lets us match an archive across a backend restart (#972):
- # same id → same print → resume the existing row instead of cancelling
- # it and recreating from scratch (which loses started_at). Treat "0"
- # and "" as absent — Bambu reports "0" for non-cloud / local prints.
- raw_mqtt = data.get("raw_data") or {}
- subtask_id = raw_mqtt.get("subtask_id")
- if subtask_id is not None:
- subtask_id = str(subtask_id).strip()
- if subtask_id in ("", "0"):
- subtask_id = None
- logger.info("[CALLBACK] Print start detected - filename: %s, subtask: %s", filename, subtask_name)
- # Skip the printer's own jobs — a calibration run is not a user's print.
- # See is_internal_printer_job for what counts and why both fields are
- # tested; the pressure-advance line reports as a subtask name with no
- # /usr/ path, which the old prefix-only test here missed entirely.
- #
- # No notification either. The event describes the printer calibrating
- # itself, so "Print started" is as wrong as the archive was, and the
- # matching completion is suppressed in on_print_complete for the same
- # reason.
- if is_internal_printer_job(filename, subtask_name):
- logger.info(
- "[CALLBACK] Skipping archive — internal printer job detected: filename=%s, subtask=%s",
- filename,
- subtask_name,
- )
- return
- if not filename and not subtask_name:
- # Send notification without archive data (no filename)
- logger.info("[CALLBACK] Skipping archive - no filename or subtask_name")
- if not notification_sent:
- await _send_print_start_notification(printer_id, data, logger=logger)
- return
- # Check if this is an expected print from reprint/scheduled
- # Build list of possible keys to check
- expected_keys = []
- if subtask_name:
- expected_keys.append((printer_id, subtask_name))
- expected_keys.append((printer_id, f"{subtask_name}.3mf"))
- expected_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
- if filename:
- fname = filename.split("/")[-1] if "/" in filename else filename
- expected_keys.append((printer_id, fname))
- # Strip extensions to match
- base = fname.replace(".gcode", "").replace(".3mf", "")
- expected_keys.append((printer_id, base))
- expected_keys.append((printer_id, f"{base}.3mf"))
- expected_archive_id = None
- for key in expected_keys:
- expected_archive_id = _expected_prints.pop(key, None)
- _expected_print_registered_at.pop(key, None)
- if expected_archive_id:
- # Clean up other possible keys for this print
- for other_key in expected_keys:
- _expected_prints.pop(other_key, None)
- _expected_print_registered_at.pop(other_key, None)
- break
- if expected_archive_id:
- # This is a reprint/scheduled print - use existing archive, don't create new one
- logger.info("Using expected archive %s for print (skipping duplicate)", expected_archive_id)
- from backend.app.models.archive import PrintArchive
- result = await db.execute(select(PrintArchive).where(PrintArchive.id == expected_archive_id))
- archive = result.scalar_one_or_none()
- if archive:
- # Update archive status to printing
- archive.status = "printing"
- archive.started_at = datetime.now(timezone.utc)
- # Reprint of an archive reuses the source row. Without resetting
- # ``timelapse_path`` _scan_for_timelapse_with_retries early-returns
- # ("already has timelapse") and _capture_finish_photo_from_timelapse
- # extracts the *original* print's last frame, which then ships in
- # the completion notification (#1707). Clear the path so the
- # scanner runs fresh; also unlink the old video file so reprints
- # don't accumulate orphans in the archive directory. Photos list
- # is left alone — accumulating one finish photo per run is fine.
- # The print-start baseline (#2704) is stale for the same reason:
- # it describes the printer before the previous run. The capture
- # below overwrites it, but clear it here too so an early failure
- # can't leave the scan diffing against the wrong snapshot.
- archive.timelapse_baseline = None
- stale_timelapse_relpath = archive.timelapse_path
- if stale_timelapse_relpath:
- archive.timelapse_path = None
- try:
- stale_path = app_settings.base_dir / stale_timelapse_relpath
- if stale_path.is_file():
- stale_path.unlink()
- logger.info(
- "Deleted stale timelapse %s on reprint of archive %s",
- stale_timelapse_relpath,
- expected_archive_id,
- )
- except OSError as e:
- logger.warning(
- "Failed to delete stale timelapse %s on reprint: %s",
- stale_timelapse_relpath,
- e,
- )
- # Persist a restart-stable id so a later restart resumes this
- # archive by subtask_id instead of name-matching + duplicating
- # it (#1485). The printer often hasn't echoed subtask_id back
- # this soon after dispatch, so fall back to the id Bambuddy
- # minted when it sent the print command. Scoped to this
- # expected-print branch on purpose: an expected match means
- # Bambuddy dispatched this exact print in this process, so the
- # client's last-dispatch id genuinely belongs to it — using it
- # for an externally-started print could mis-tag the archive.
- effective_subtask_id = subtask_id
- if not effective_subtask_id:
- _client = printer_manager.get_client(printer_id)
- _dispatched = getattr(_client, "last_dispatch_subtask_id", None) if _client else None
- if _dispatched:
- effective_subtask_id = str(_dispatched).strip() or None
- # Update on first-set OR on reprint (the queue dispatcher mints
- # a fresh subtask_id per dispatch in bambu_mqtt:3647). Skipping
- # the rewrite for reprints leaves the archive holding the FIRST
- # run's id; if MQTT then reconnects mid-print, the reconciler
- # (#1542) compares the stale stored id against the printer's
- # live id, sees a mismatch, and synthesises a bogus PRINT
- # COMPLETE — exactly the false-positive "Print Stopped" reported
- # in #1807. Inequality check preserves the noop-on-stable-push
- # behaviour the earlier `not archive.subtask_id` guard provided.
- if effective_subtask_id and archive.subtask_id != effective_subtask_id:
- archive.subtask_id = effective_subtask_id
- # #1403 follow-up: VP-queue archives are created with
- # printer_id=None at queue-add time (we don't know which
- # printer will run the job yet). When the print actually
- # starts on a specific printer the expected-archive lookup
- # used to skip this assignment, leaving printer_id=None
- # forever — which then disables the "Scan for timelapse"
- # button in ArchivesPage (gated on !archive.printer_id).
- if archive.printer_id != printer_id:
- archive.printer_id = printer_id
- await db.commit()
- # Track as active print
- _active_prints[(printer_id, archive.filename)] = archive.id
- if subtask_name:
- _active_prints[(printer_id, f"{subtask_name}.3mf")] = archive.id
- # Start timelapse session if external camera is enabled (#1353).
- # Queue / VP-dispatched prints land here in the expected-archive
- # branch and used to skip start_session entirely — frames were
- # never captured and the post-print stitch silently returned None.
- _maybe_start_layer_timelapse(printer, printer_id, archive.id)
- # Inject ams_mapping into usage tracker session — the session was created
- # before expected-print promotion, so it may have ams_mapping=None when
- # the MQTT request topic subscription failed (common on P1S/A1).
- _stored_map = _print_ams_mappings.get(expected_archive_id)
- _stored_plate_id = _print_plate_ids.get(expected_archive_id)
- if _stored_map or _stored_plate_id is not None:
- try:
- from backend.app.services.usage_tracker import _active_sessions
- _ut_session = _active_sessions.get(printer_id)
- if _ut_session and _stored_map and not _ut_session.ams_mapping:
- _ut_session.ams_mapping = _stored_map
- logger.info("[CALLBACK] Injected ams_mapping into usage tracker session: %s", _stored_map)
- # plate_id injection covers direct-Print of plate N of a multi-plate
- # 3MF — queue prints already capture it via the on_print_start queue
- # lookup, but direct-Print never goes through the queue (#1697).
- if _ut_session and _stored_plate_id is not None and _ut_session.plate_id is None:
- _ut_session.plate_id = _stored_plate_id
- logger.info("[CALLBACK] Injected plate_id into usage tracker session: %s", _stored_plate_id)
- except Exception:
- pass
- # Set up energy tracking (#941: persist start on archive row)
- await _record_energy_start(archive, printer_id, db, context="expected-print")
- await ws_manager.send_archive_updated(
- {
- "id": archive.id,
- "status": "printing",
- }
- )
- # Send notification with archive data (reprint/scheduled)
- if not notification_sent:
- # Use archive's created_by_id; fall back to the creator registered via
- # register_expected_print (handles library-file-based queue items where
- # the freshly-created archive has no created_by_id yet).
- # Pop ALL matching keys so no stale entries remain in the dict.
- fallback_creator = None
- for key in expected_keys:
- popped = _expected_print_creators.pop(key, None)
- if fallback_creator is None:
- fallback_creator = popped
- archive_data = {
- "print_time_seconds": archive.print_time_seconds,
- "created_by_id": archive.created_by_id or fallback_creator,
- }
- await _send_print_start_notification(printer_id, data, archive_data, logger)
- # Extract printable objects from the archived 3MF file
- _load_objects_from_archive(archive, printer_id, logger)
- # Store Spoolman tracking data for per-filament usage reporting
- try:
- await _store_spoolman_print_data(
- printer_id,
- archive.id,
- archive.file_path,
- db,
- printer_manager,
- ams_mapping=_get_start_ams_mapping(data, archive.id),
- plate_id=_get_start_plate_id(archive.id),
- )
- except Exception as e:
- logger.warning("[SPOOLMAN] Failed to store tracking data: %s", e)
- # Capture timelapse file baseline for snapshot-diff on completion
- # (mirrors the new-archive branch). Queue / VP-dispatched prints
- # hit this branch — without the baseline the completion-time scan
- # falls into its "take baseline now" fallback, which snapshots
- # AFTER the new MP4 already exists and never matches a diff
- # (#1403 follow-up — see pwostran's 2026-05-18 support bundle).
- await _capture_timelapse_baseline_at_start(printer, printer_id, logger, archive_id=archive.id)
- return # Skip creating a new archive
- # Check if there's already a "printing" archive for this printer/file
- # This prevents duplicates when backend restarts during an active print
- from backend.app.models.archive import PrintArchive
- existing_archive: PrintArchive | None = None
- # Preferred match: subtask_id equality. MQTT reports the same subtask_id
- # across a backend restart for the same print, so this is the most
- # reliable way to reattach. We also accept a previously stale-cancelled
- # archive here so users upgrading mid-print get revived when the row
- # their earlier Bambuddy version wrongly cancelled reappears (#972).
- if subtask_id:
- by_id = await db.execute(
- select(PrintArchive)
- .where(PrintArchive.printer_id == printer_id)
- .where(PrintArchive.subtask_id == subtask_id)
- .where(PrintArchive.status.in_(["printing", "cancelled"]))
- .order_by(PrintArchive.created_at.desc())
- .limit(1)
- )
- candidate = by_id.scalar_one_or_none()
- if candidate and (candidate.status == "printing" or (candidate.failure_reason or "").startswith("Stale")):
- existing_archive = candidate
- # Fallback match: name-based lookup. Kept as-is for prints whose
- # subtask_id is missing ("0" / local / non-cloud prints).
- if existing_archive is None:
- check_name = subtask_name or filename.split("/")[-1].replace(".gcode", "").replace(".3mf", "")
- existing = await db.execute(
- select(PrintArchive)
- .where(PrintArchive.printer_id == printer_id)
- .where(PrintArchive.status == "printing")
- .where(
- or_(
- PrintArchive.print_name == check_name,
- PrintArchive.filename.in_(
- [
- f"{check_name}.3mf",
- f"{check_name}.gcode.3mf",
- ]
- ),
- )
- )
- .order_by(PrintArchive.created_at.desc())
- .limit(1)
- )
- existing_archive = existing.scalar_one_or_none()
- if existing_archive:
- # subtask_id match → always resume, regardless of age. Same print,
- # just a backend restart. Revive if it was previously stale-cancelled.
- subtask_match = bool(subtask_id and existing_archive.subtask_id == subtask_id)
- if subtask_match:
- if existing_archive.status == "cancelled":
- logger.warning(
- "Reviving stale-cancelled archive %s — matching subtask_id %s confirms same print (#972)",
- existing_archive.id,
- subtask_id,
- )
- existing_archive.status = "printing"
- existing_archive.failure_reason = None
- await db.commit()
- else:
- logger.info("Resuming archive %s on subtask_id match (%s)", existing_archive.id, subtask_id)
- _active_prints[(printer_id, existing_archive.filename)] = existing_archive.id
- if existing_archive.energy_start_kwh is None:
- await _record_energy_start(existing_archive, printer_id, db, context="subtask-resume")
- if not notification_sent:
- archive_data = {
- "print_time_seconds": existing_archive.print_time_seconds,
- "created_by_id": existing_archive.created_by_id,
- }
- await _send_print_start_notification(printer_id, data, archive_data, logger)
- _load_objects_from_archive(existing_archive, printer_id, logger)
- return
- # Name-match only (no subtask_id to anchor on): decide resume vs.
- # stale from the printer's *current* progress, not wall-clock age.
- # A genuinely long print used to trip a blind 4h cutoff and have its
- # live archive cancelled + duplicated on every backend restart
- # (#1485). If the printer reports real progress, this name-matched
- # 'printing' archive IS that ongoing print — resume it whatever its
- # age. Only treat it as a stale leftover when the printer clearly
- # shows a different, freshly-started print: near-0% progress on an
- # archive far too old to still be at 0%. Unknown progress (printer
- # not connected) never cancels — resuming is the safe default.
- archive_age = datetime.now(timezone.utc) - existing_archive.created_at.replace(tzinfo=timezone.utc)
- live_status = printer_manager.get_status(printer_id)
- live_progress = getattr(live_status, "progress", None) if live_status else None
- looks_stale = (
- live_progress is not None and live_progress < 1.0 and archive_age.total_seconds() > 2 * 60 * 60
- )
- if looks_stale:
- logger.warning(
- f"Found stale 'printing' archive {existing_archive.id} (age: {archive_age}, "
- f"printer progress {live_progress:.0f}%) — marking cancelled and creating new archive"
- )
- existing_archive.status = "cancelled"
- # Canonical key, not a sentence (issue #2974). "No status update
- # received" is what both stale paths actually observed; which of
- # the two it was is already carried by ``status`` -- cancelled
- # here, the reconciled outcome at the reconnect site -- so one
- # key loses no information and gives the Statistics breakdown a
- # single bucket instead of two untranslatable prose strings.
- existing_archive.failure_reason = "noStatusUpdate"
- await db.commit()
- # Fall through to create new archive (don't return)
- else:
- logger.info(
- f"Skipping duplicate - already have printing archive {existing_archive.id} for {check_name}"
- )
- # Track this as the active print
- _active_prints[(printer_id, existing_archive.filename)] = existing_archive.id
- # Attach subtask_id retroactively so future restarts can resume.
- # Compare for inequality (not "is empty") to also pick up reprint
- # dispatches that mint a fresh id — see #1807 for the bogus
- # "Print Stopped" the strict-empty guard caused on reconnect.
- if subtask_id and existing_archive.subtask_id != subtask_id:
- existing_archive.subtask_id = subtask_id
- await db.commit()
- # Also set up energy tracking if not already tracked (#941: persisted column)
- if existing_archive.energy_start_kwh is None:
- await _record_energy_start(existing_archive, printer_id, db, context="existing-printing")
- # Send notification with archive data (existing archive)
- if not notification_sent:
- archive_data = {
- "print_time_seconds": existing_archive.print_time_seconds,
- "created_by_id": existing_archive.created_by_id,
- }
- await _send_print_start_notification(printer_id, data, archive_data, logger)
- # Extract printable objects from the archived 3MF file
- _load_objects_from_archive(existing_archive, printer_id, logger)
- return
- # Build list of possible 3MF filenames to try
- possible_names = []
- # Bambu printers typically store files as "Name.gcode.3mf"
- # The subtask_name is usually the best source for the filename
- if subtask_name:
- # Try common Bambu naming patterns
- possible_names.append(f"{subtask_name}.gcode.3mf")
- possible_names.append(f"{subtask_name}.3mf")
- # Try original filename with .3mf extension
- if filename:
- # Extract just the filename part, not the full path
- fname = filename.split("/")[-1] if "/" in filename else filename
- if fname.endswith(".3mf"):
- possible_names.append(fname)
- elif fname.endswith(".gcode"):
- base = fname.rsplit(".", 1)[0]
- possible_names.append(f"{base}.gcode.3mf")
- possible_names.append(f"{base}.3mf")
- else:
- possible_names.append(f"{fname}.gcode.3mf")
- possible_names.append(f"{fname}.3mf")
- # Also try with spaces converted to underscores (Bambu Studio may normalize filenames)
- space_variants = []
- for name in possible_names:
- if " " in name:
- space_variants.append(name.replace(" ", "_"))
- possible_names.extend(space_variants)
- # Remove duplicates while preserving order
- seen = set()
- possible_names = [x for x in possible_names if not (x in seen or seen.add(x))]
- logger.info("Trying filenames: %s", possible_names)
- # Release the pooled DB connection before the 3MF FTP download. Reaching
- # here means none of the expected-/existing-archive write branches ran
- # (they all return earlier) — only SELECTs have executed on this path, so
- # this commit persists nothing; it ends the read transaction so the
- # connection returns to the pool during the download. That download tries
- # up to five remote paths per candidate filename with retry/backoff and
- # can run for minutes under FTP contention; holding the session across it
- # pinned one pooled connection idle-in-transaction (issue #2572). No DB
- # work runs during the download — the new-archive writes below re-acquire
- # a fresh connection, and expire_on_commit=False keeps printer.* readable.
- await db.commit()
- # Try to find and download the 3MF file
- temp_path = None
- downloaded_filename = None
- # Cache check: cover endpoint may have already pulled this 3MF during
- # the print (frontend opens the card and shows the thumbnail) — reuse
- # that file instead of re-downloading 36MB over the same FTP link that
- # just served it (#972). The cache keys on a normalized filename so
- # variants like "X", "X.3mf", "X.gcode.3mf" all collapse to one entry.
- for try_filename in possible_names:
- if not try_filename.endswith(".3mf"):
- continue
- cached = get_cached_3mf(printer_id, try_filename)
- if cached:
- logger.info("Reusing cached 3MF from %s (avoided duplicate FTP)", cached)
- temp_path = cached
- downloaded_filename = try_filename
- break
- # Does this printer keep the sliced file somewhere FTPS can reach? On
- # H2-series and P2S the answer is routinely no — the file stays on
- # internal eMMC and port 990 only ever serves external storage — and
- # then the whole sweep below (six filenames x five directories x four
- # retries, then the directory walk) is ~110 connections that cannot
- # succeed. Skip it and say why (#2780).
- storage = print_file_reachable_over_ftp(printer_manager.get_status(printer_id))
- # Set when a lookup is abandoned because the printer's FTPS cool-off is
- # running rather than because the file is somewhere unreachable. The
- # distinction is the whole of #2957: one is permanent, the other clears
- # in minutes with the file still sitting on the printer.
- blocked_by_ftps_cooloff = False
- # Get FTP retry settings
- ftp_retry_enabled, ftp_retry_count, ftp_retry_delay, ftp_timeout = await get_ftp_retry_settings()
- # ...but "the printer put it on eMMC" is where it went, not whether we
- # can read it. An H2D with a card in mirrors the job to /cache and
- # serves it happily, and skipping on the URL alone cost that reporter
- # every archive for two days (#2856). So ask the printer instead of
- # guessing: the dispatch named the exact file, which is one connection
- # walking five paths rather than the sweep's ~110. Only when the probe
- # comes back empty does the verdict's reason stand.
- if not storage.reachable and not downloaded_filename and storage.probe_filename:
- if ftps_handshake_blocked(printer.ip_address):
- # Deliberately NOT recorded as a cool-off give-up. This branch
- # only runs on an unreachable verdict, and that verdict is the
- # honest, permanent reason the archive is empty — the probe was
- # a long shot on top of it. Blaming the cool-off here would
- # schedule a retry for a file sitting on internal eMMC, which is
- # the sweep #2780 removed (#2957).
- logger.debug(
- "Not probing for %s on printer %s: its file service is not answering over TLS",
- storage.probe_filename,
- printer_id,
- )
- else:
- probe_path = app_settings.archive_dir / "temp" / storage.probe_filename
- probe_path.parent.mkdir(parents=True, exist_ok=True)
- try:
- probe_hit = await download_file_try_paths_async(
- printer.ip_address,
- printer.access_code,
- ftp_probe_paths(storage.probe_filename),
- probe_path,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- )
- except Exception as e:
- logger.debug("3MF probe for %s failed: %s", storage.probe_filename, e)
- probe_hit = False
- if probe_hit:
- downloaded_filename = storage.probe_filename
- temp_path = probe_path
- cache_3mf_download(printer_id, downloaded_filename, probe_path)
- # Naming the path, not just the file: a printer that keeps
- # uploads around for weeks can serve a same-named copy of an
- # earlier slice, and without the directory in the log that
- # mismatch is invisible rather than merely rare (#1820).
- logger.info(
- "Found %s at %s over FTPS for printer %s even though the printer reported %s",
- downloaded_filename,
- probe_hit,
- printer_id,
- storage.reason,
- )
- if not storage.reachable and not downloaded_filename:
- # Same opening words whether or not a probe ran, because that is
- # the phrase support asks people to grep for — only the tail says
- # which of the two happened.
- logger.info(
- "Skipping the 3MF lookup for printer %s: %s — %s",
- printer_id,
- storage.reason,
- "no copy of it on external storage either"
- if storage.probe_filename
- else "the print file is not on storage Bambuddy can read over FTPS, so no path would find it",
- )
- for try_filename in possible_names if not downloaded_filename and storage.reachable else []:
- if not try_filename.endswith(".3mf"):
- continue
- # Root (/) is where BambuStudio/OrcaSlicer uploads land on A1/P1-series
- # printers, so try it first — deferring it to last cost #972's reporter
- # ~48 minutes of retries on /cache//model//data//data/Metadata before
- # landing on the path that actually had the file.
- remote_paths = [
- f"/{try_filename}",
- f"/cache/{try_filename}",
- f"/model/{try_filename}",
- f"/data/{try_filename}",
- f"/data/Metadata/{try_filename}",
- ]
- temp_path = app_settings.archive_dir / "temp" / try_filename
- temp_path.parent.mkdir(parents=True, exist_ok=True)
- for remote_path in remote_paths:
- if ftps_handshake_blocked(printer.ip_address):
- # The printer's FTPS service is not completing a TLS
- # handshake, so it has no path we could reach — walking the
- # remaining candidates only re-runs the same failure
- # (#2780). Fall through to the no-3MF archive now.
- #
- # Remember *why*, though. This is the one give-up that is
- # temporary: the cool-off clears in minutes and the file was
- # on the printer the whole time. The fallback archive is
- # stamped with it so a retry can be scheduled, and so the
- # Archives banner stops blaming storage (#2957).
- blocked_by_ftps_cooloff = True
- logger.warning(
- "Giving up on the 3MF for printer %s: its file service is not answering over TLS",
- printer_id,
- )
- break
- logger.debug("Trying FTP download: %s", remote_path)
- try:
- if ftp_retry_enabled:
- downloaded = await with_ftp_retry(
- download_file_async,
- printer.ip_address,
- printer.access_code,
- remote_path,
- temp_path,
- timeout=ftp_timeout,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- max_retries=ftp_retry_count,
- retry_delay=ftp_retry_delay,
- operation_name=f"Download 3MF from {remote_path}",
- cooloff_ip=printer.ip_address,
- non_retry_exceptions=(FileNotOnPrinterError,),
- )
- else:
- downloaded = await download_file_async(
- printer.ip_address,
- printer.access_code,
- remote_path,
- temp_path,
- timeout=ftp_timeout,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- )
- if downloaded:
- downloaded_filename = try_filename
- logger.info("Downloaded: %s", remote_path)
- # Populate shared cache so the cover endpoint (if it
- # runs next) doesn't refetch the same 36MB over FTP.
- cache_3mf_download(printer_id, try_filename, temp_path)
- break
- except FileNotOnPrinterError:
- # 550 — file isn't at this path. Advance to next candidate
- # without burning the retry budget.
- logger.debug("3MF not at %s (550), trying next path", remote_path)
- except Exception as e:
- logger.debug("FTP download failed for %s: %s", remote_path, e)
- if downloaded_filename or ftps_handshake_blocked(printer.ip_address):
- break
- # If still not found, try listing directories to find matching file
- # Different printer models use different directory structures. Skipped
- # when the printer's FTPS handshake is failing — the directory walk is
- # five more connections that cannot get further than the download did.
- if (
- not downloaded_filename
- and storage.reachable
- and (filename or subtask_name)
- and not ftps_handshake_blocked(printer.ip_address)
- ):
- search_term = (subtask_name or filename).lower().replace(".gcode", "").replace(".3mf", "")
- logger.info("Direct FTP download failed, searching directories for '%s'", search_term)
- search_dirs = ["/cache", "/model", "/data", "/data/Metadata", "/"]
- for search_dir in search_dirs:
- if downloaded_filename:
- break
- try:
- dir_files = await list_files_async(
- printer.ip_address, printer.access_code, search_dir, printer_model=printer.model
- )
- threemf_files = [f.get("name") for f in dir_files if f.get("name", "").endswith(".3mf")]
- if threemf_files:
- logger.info(
- f"Found {len(threemf_files)} 3MF files in {search_dir}: {threemf_files[:5]}{'...' if len(threemf_files) > 5 else ''}"
- )
- for f in dir_files:
- if f.get("is_directory"):
- continue
- fname = f.get("name", "")
- # Normalize both for comparison (spaces and underscores are equivalent)
- fname_normalized = fname.lower().replace(" ", "_")
- search_normalized = search_term.replace(" ", "_")
- if fname.endswith(".3mf") and search_normalized in fname_normalized:
- logger.info("Found matching file in %s: %s", search_dir, fname)
- temp_path = app_settings.archive_dir / "temp" / fname
- temp_path.parent.mkdir(parents=True, exist_ok=True)
- remote_full_path = posixpath.join(search_dir, fname)
- if ftp_retry_enabled:
- downloaded = await with_ftp_retry(
- download_file_async,
- printer.ip_address,
- printer.access_code,
- remote_full_path,
- temp_path,
- timeout=ftp_timeout,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- max_retries=ftp_retry_count,
- retry_delay=ftp_retry_delay,
- operation_name=f"Download 3MF from {remote_full_path}",
- cooloff_ip=printer.ip_address,
- )
- else:
- downloaded = await download_file_async(
- printer.ip_address,
- printer.access_code,
- remote_full_path,
- temp_path,
- timeout=ftp_timeout,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- )
- if downloaded:
- downloaded_filename = fname
- logger.info("Found and downloaded from %s: %s", search_dir, fname)
- cache_3mf_download(printer_id, fname, temp_path)
- break
- except Exception as e:
- logger.debug("Failed to list %s: %s", search_dir, e)
- # Validate the downloaded 3MF actually matches the plate that's running
- # (#1204): subtask_name lags across consecutive plates of the same model,
- # so the first FTP candidate (built from subtask_name) can land on the
- # previous plate's still-resident upload. Cross-check the slice_info
- # plate index against the plate parsed from gcode_file (always fresh —
- # it's the field whose change triggered this callback).
- if downloaded_filename and temp_path:
- expected_plate = parse_plate_id(filename)
- actual_plate = peek_plate_index_in_3mf(temp_path) if expected_plate is not None else None
- if expected_plate is not None and actual_plate is not None and actual_plate != expected_plate:
- logger.warning(
- "[CALLBACK] 3MF plate mismatch: downloaded %s reports plate %s but printer is "
- "running plate %s — subtask_name=%r appears stale, retrying with corrected name",
- downloaded_filename,
- actual_plate,
- expected_plate,
- subtask_name,
- )
- corrected_subtask = swap_plate_suffix(subtask_name, expected_plate)
- retry_succeeded = False
- if corrected_subtask and corrected_subtask != subtask_name:
- for try_filename in (f"{corrected_subtask}.gcode.3mf", f"{corrected_subtask}.3mf"):
- retry_temp_path = app_settings.archive_dir / "temp" / try_filename
- retry_temp_path.parent.mkdir(parents=True, exist_ok=True)
- for remote_path in (
- f"/{try_filename}",
- f"/cache/{try_filename}",
- f"/model/{try_filename}",
- f"/data/{try_filename}",
- f"/data/Metadata/{try_filename}",
- ):
- try:
- if ftp_retry_enabled:
- downloaded = await with_ftp_retry(
- download_file_async,
- printer.ip_address,
- printer.access_code,
- remote_path,
- retry_temp_path,
- timeout=ftp_timeout,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- max_retries=ftp_retry_count,
- retry_delay=ftp_retry_delay,
- operation_name=f"Re-download 3MF from {remote_path}",
- cooloff_ip=printer.ip_address,
- non_retry_exceptions=(FileNotOnPrinterError,),
- )
- else:
- downloaded = await download_file_async(
- printer.ip_address,
- printer.access_code,
- remote_path,
- retry_temp_path,
- timeout=ftp_timeout,
- socket_timeout=ftp_timeout,
- printer_model=printer.model,
- )
- if downloaded and peek_plate_index_in_3mf(retry_temp_path) == expected_plate:
- logger.info(
- "[CALLBACK] Re-download succeeded with corrected name %s "
- "(plate %s) — replacing wrong file",
- try_filename,
- expected_plate,
- )
- try:
- temp_path.unlink(missing_ok=True)
- except OSError:
- pass
- temp_path = retry_temp_path
- downloaded_filename = try_filename
- subtask_name = corrected_subtask
- cache_3mf_download(printer_id, try_filename, temp_path)
- retry_succeeded = True
- break
- elif downloaded:
- # Wrong plate again — discard and keep trying
- try:
- retry_temp_path.unlink(missing_ok=True)
- except OSError:
- pass
- except FileNotOnPrinterError:
- continue
- except Exception as e:
- logger.debug("Re-download failed for %s: %s", remote_path, e)
- if retry_succeeded:
- break
- # If the retry didn't find a matching file, drop the wrong 3MF
- # so the no-3MF fallback below creates an archive whose name
- # at least reflects the right plate.
- if not retry_succeeded:
- logger.warning(
- "[CALLBACK] Could not re-download correct plate %s — falling back to no-3MF archive",
- expected_plate,
- )
- try:
- temp_path.unlink(missing_ok=True)
- except OSError:
- pass
- temp_path = None
- downloaded_filename = None
- # Override the stale subtask_name so the fallback archive's
- # print_name reflects the correct plate. Prefer the swapped
- # name when we have one; otherwise let filename win.
- if corrected_subtask:
- subtask_name = corrected_subtask
- else:
- subtask_name = ""
- if not downloaded_filename or not temp_path:
- logger.warning("Could not find 3MF file for print: %s", filename or subtask_name)
- # Create a fallback archive without 3MF data so the print is still tracked
- # This commonly happens with P1S/A1 printers where FTP has file size limitations
- try:
- from backend.app.models.archive import PrintArchive
- # Derive print name from subtask_name or filename
- print_name = subtask_name or filename
- if print_name:
- # Clean up the name (remove extensions, path parts)
- print_name = print_name.split("/")[-1]
- print_name = print_name.replace(".gcode.3mf", "").replace(".gcode", "").replace(".3mf", "")
- else:
- print_name = "Unknown Print"
- # Recover estimated print time from MQTT (best-effort for notifications)
- fallback_print_time = None
- mqtt_remaining = data.get("remaining_time")
- if mqtt_remaining and isinstance(mqtt_remaining, (int, float)) and mqtt_remaining > 0:
- fallback_print_time = int(mqtt_remaining)
- if fallback_print_time is None:
- mc_remaining = (data.get("raw_data") or {}).get("mc_remaining_time")
- if mc_remaining and isinstance(mc_remaining, (int, float)) and mc_remaining > 0:
- fallback_print_time = int(mc_remaining * 60)
- # Best-effort filament metadata from MQTT — see
- # _extract_filament_data_from_mqtt. Without this the fallback
- # archive's filament fields stayed NULL even though the AMS
- # state at print start was sitting right there in `data`.
- # The slicer's ams_mapping (when present) narrows the result
- # to slots actually used by the print (#1533).
- mqtt_filament_meta = _extract_filament_data_from_mqtt(data, _get_start_ams_mapping(data, None))
- # Create minimal archive entry
- fallback_archive = PrintArchive(
- printer_id=printer_id,
- filename=filename or f"{print_name}.3mf",
- file_path="", # Empty - no 3MF file available
- file_size=0,
- print_name=print_name,
- print_time_seconds=fallback_print_time,
- status="printing",
- started_at=datetime.now(timezone.utc),
- subtask_id=subtask_id,
- filament_type=mqtt_filament_meta.get("filament_type"),
- filament_color=mqtt_filament_meta.get("filament_color"),
- extra_data={
- "no_3mf_available": True,
- # Why the card is empty, when we know. The banner reads
- # this to stop telling H2/P2 owners to switch on a
- # setting that is already on and would not help (#2780).
- # A cool-off outranks the storage verdict: the sweep was
- # skipped at the transport, so the verdict never got to
- # be tested, and reporting it would blame the SD card
- # for a TLS handshake (#2957).
- "no_3mf_reason": REASON_FTPS_COOLOFF if blocked_by_ftps_cooloff else storage.reason,
- "original_subtask": subtask_name,
- "_print_data": data,
- },
- )
- db.add(fallback_archive)
- await db.commit()
- await db.refresh(fallback_archive)
- logger.info("Created fallback archive %s for %s (no 3MF available)", fallback_archive.id, print_name)
- _maybe_start_layer_timelapse(printer, printer_id, fallback_archive.id)
- # Track as active print
- _active_prints[(printer_id, fallback_archive.filename)] = fallback_archive.id
- if filename:
- _active_prints[(printer_id, filename)] = fallback_archive.id
- if subtask_name:
- _active_prints[(printer_id, f"{subtask_name}.3mf")] = fallback_archive.id
- _active_prints[(printer_id, subtask_name)] = fallback_archive.id
- # Record starting energy if smart plug available (#941: persisted column)
- await _record_energy_start(fallback_archive, printer_id, db, context="fallback")
- # Send WebSocket notification
- await ws_manager.send_archive_created(
- {
- "id": fallback_archive.id,
- "printer_id": fallback_archive.printer_id,
- "filename": fallback_archive.filename,
- "print_name": fallback_archive.print_name,
- "status": fallback_archive.status,
- }
- )
- # MQTT relay - publish archive created
- try:
- await mqtt_relay.on_archive_created(
- archive_id=fallback_archive.id,
- print_name=fallback_archive.print_name,
- printer_name=printer.name,
- status=fallback_archive.status,
- )
- except Exception:
- pass # Don't fail if MQTT fails
- # Store Spoolman tracking data (may not work for fallback since no 3MF)
- try:
- await _store_spoolman_print_data(
- printer_id,
- fallback_archive.id,
- fallback_archive.file_path,
- db,
- printer_manager,
- ams_mapping=_get_start_ams_mapping(data, fallback_archive.id),
- plate_id=_get_start_plate_id(fallback_archive.id),
- )
- except Exception as e:
- logger.debug("[SPOOLMAN] Could not store tracking for fallback archive: %s", e)
- # A cool-off give-up is temporary and the file is on the
- # printer — come back for it once the handshake block clears
- # (#2957). Deliberately not scheduled for a storage verdict:
- # a file on internal eMMC will not appear at any FTPS path
- # however long we wait, and retrying it is exactly the sweep
- # #2780 removed.
- if blocked_by_ftps_cooloff and possible_names:
- # `possible_names`, not the raw MQTT strings: it is the exact
- # list this flow just tried, already stripped of any path
- # (`filename` arrives as "/data/Metadata/plate_1.gcode" on
- # some firmware) and deduped.
- _schedule_fallback_3mf_retry(
- printer_id=printer_id,
- archive_id=fallback_archive.id,
- filenames=list(possible_names),
- )
- # Send notification without archive data (file not found)
- if not notification_sent:
- await _send_print_start_notification(printer_id, data, logger=logger)
- # The same baseline the other two on_print_start branches take
- # (#2704), and last for the same reason they are: it lists the
- # printer's timelapse directory, so a slow card must not delay
- # the _active_prints registration, the energy reading, the
- # archive-created event or the start notification above it.
- #
- # This branch never took one, so every no-3MF archive reached
- # completion with no baseline in memory and none on the row, and
- # the completion scan fell into its "snapshot now" fallback --
- # which runs after the printer has written the video, so the new
- # file landed inside the baseline and no diff ever matched
- # (#2957 follow-up).
- #
- # Skipped when the FTPS cool-off is what produced this fallback:
- # the listing needs the same connection that just failed, so it
- # could only record that the card was unreadable. The scan
- # handles that case by refusing to choose between candidates.
- if not blocked_by_ftps_cooloff:
- await _capture_timelapse_baseline_at_start(
- printer, printer_id, logger, archive_id=fallback_archive.id
- )
- return
- except Exception as e:
- logger.error("Failed to create fallback archive: %s", e)
- # Send notification without archive data (file not found)
- if not notification_sent:
- await _send_print_start_notification(printer_id, data, logger=logger)
- return
- try:
- # Archive the file with status "printing"
- service = ArchiveService(db)
- archive = await service.archive_print(
- printer_id=printer_id,
- source_file=temp_path,
- print_data={**data, "status": "printing"},
- subtask_id=subtask_id,
- )
- if archive:
- # Track this active print (use both original filename and downloaded filename)
- _active_prints[(printer_id, downloaded_filename)] = archive.id
- if filename and filename != downloaded_filename:
- _active_prints[(printer_id, filename)] = archive.id
- if subtask_name:
- _active_prints[(printer_id, f"{subtask_name}.3mf")] = archive.id
- logger.info("Created archive %s for %s", archive.id, downloaded_filename)
- _maybe_start_layer_timelapse(printer, printer_id, archive.id)
- # Record starting energy from smart plug if available (#941: persisted column)
- await _record_energy_start(archive, printer_id, db, context="auto-archive")
- await ws_manager.send_archive_created(
- {
- "id": archive.id,
- "printer_id": archive.printer_id,
- "filename": archive.filename,
- "print_name": archive.print_name,
- "status": archive.status,
- }
- )
- # MQTT relay - publish archive created
- try:
- await mqtt_relay.on_archive_created(
- archive_id=archive.id,
- print_name=archive.print_name,
- printer_name=printer.name,
- status=archive.status,
- )
- except Exception:
- pass # Don't fail if MQTT fails
- # Send notification with archive data (new archive created)
- if not notification_sent:
- archive_data = {
- "print_time_seconds": archive.print_time_seconds,
- "created_by_id": archive.created_by_id,
- }
- await _send_print_start_notification(printer_id, data, archive_data, logger)
- # Extract printable objects for skip object functionality
- try:
- from backend.app.services.archive import extract_printable_objects_from_3mf
- client = printer_manager.get_client(printer_id)
- if client:
- with open(temp_path, "rb") as f:
- threemf_data = f.read()
- # Extract with positions for UI overlay, scoped to the
- # plate that is printing — an all-plates 3MF carries
- # every plate's objects (#2522).
- printable_objects, bbox_all = extract_printable_objects_from_3mf(
- threemf_data,
- plate_number=resolve_plate_id(client.state),
- include_positions=True,
- )
- if printable_objects:
- # Store objects in printer state
- client.state.printable_objects = printable_objects
- client.state.printable_objects_bbox_all = bbox_all
- client.state.skipped_objects = [] # Reset skipped objects for new print
- logger.info(
- "Loaded %s printable objects for printer %s", len(printable_objects), printer_id
- )
- except Exception as e:
- logger.debug("Failed to extract printable objects: %s", e)
- # Store Spoolman tracking data for per-filament usage reporting
- try:
- await _store_spoolman_print_data(
- printer_id,
- archive.id,
- archive.file_path,
- db,
- printer_manager,
- ams_mapping=_get_start_ams_mapping(data, archive.id),
- plate_id=_get_start_plate_id(archive.id),
- )
- except Exception as e:
- logger.warning("[SPOOLMAN] Failed to store tracking data: %s", e)
- # Capture timelapse file baseline for snapshot-diff on completion
- await _capture_timelapse_baseline_at_start(printer, printer_id, logger, archive_id=archive.id)
- finally:
- # Keep temp_path around until print completes so the cover endpoint
- # can reuse it (#972). Cache eviction in on_print_complete deletes
- # the file. If the cache entry was evicted early (file vanished),
- # clean up any stragglers here to avoid leaking disk on retries.
- cached_now = get_cached_3mf(printer_id, downloaded_filename) if downloaded_filename else None
- if temp_path and temp_path.exists() and cached_now != temp_path:
- temp_path.unlink()
- _TIMELAPSE_VIDEO_EXTENSIONS = (".mp4", ".avi")
- # Poll schedule for the post-print timelapse scan (#2704). Module-level so
- # tests can shrink them without waiting out real delays.
- #
- # This replaced a fixed [5, 10, 20, 30] retry ladder, i.e. roughly 65 s of
- # looking. Across 247 support bundles the attempt that found the video was #1
- # 272 times, then 17 / 13 / 13 — a flat tail against the cutoff rather than a
- # decaying one, which is the signature of a budget that expires while files are
- # still arriving. 457 scans were scheduled and only 262 ever attached. Big
- # prints make big videos and the printer writes them after the print ends, so
- # the poll now runs for minutes and costs one FTP LIST per round.
- _TIMELAPSE_SCAN_FIRST_DELAY_SECONDS: float = 5.0
- _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS: float = 30.0
- _TIMELAPSE_SCAN_TIMEOUT_SECONDS: float = 900.0
- def _timelapse_scan_max_attempts() -> int:
- """Round cap for the poll, derived from the wall-clock budget.
- The deadline alone is not a sufficient bound: it assumes each round really
- waits, which stops being true the moment ``asyncio.sleep`` is patched out,
- and an FTP list that fails immediately would otherwise spin against the
- printer at full speed for the whole window. Whichever bound is reached
- first ends the poll.
- """
- if _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS <= 0:
- # A zero interval makes the wall-clock budget meaningless; fall back to
- # the round count the production interval would have given.
- return 32
- return max(1, int(_TIMELAPSE_SCAN_TIMEOUT_SECONDS // _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS) + 1)
- async def _claimed_timelapse_names(db, printer_id: int, exclude_archive_id: int) -> set[str]:
- """Video filenames already attached to some other archive of this printer.
- Used to disambiguate when more than one file is new since the baseline —
- which happens when a previous print's video landed after this print's
- baseline was taken. Ordering the candidates would be the obvious fix and is
- the wrong one: it can only be done on mtime or on the filename timestamp,
- both of which come from the printer's own clock, and a LAN-only printer
- can't reach Bambu's NTP server. Exclusion needs no clock at all.
- ``attach_timelapse`` saves the video into the archive directory under the
- printer's original filename, and the later MP4 conversion keeps the stem,
- so the stem of ``timelapse_path`` recovers what was claimed.
- """
- from backend.app.models.archive import PrintArchive
- rows = await db.execute(
- select(PrintArchive.timelapse_path).where(
- PrintArchive.printer_id == printer_id,
- PrintArchive.id != exclude_archive_id,
- PrintArchive.timelapse_path.is_not(None),
- )
- )
- return {Path(p).stem for p in rows.scalars().all() if p}
- def _timelapse_listing_is_trustworthy(printer) -> bool:
- """Whether an *empty* timelapse listing for *printer* can be believed.
- ``list_files_async`` answers ``[]`` when its connect fails rather than
- raising, so a card behind the FTPS handshake cool-off is indistinguishable
- from one holding no videos. Everywhere that only wants to know "is there a
- video yet" the difference does not matter — both mean "not yet, retry".
- It matters where an empty listing is recorded as a *baseline*. Recording
- "the card held nothing" for a card that was never read means every video on
- it counts as new once the cool-off expires, and the completion scan then
- attaches a stale video to this print and deletes it from the printer
- (#2957 follow-up). Those two callers ask this first.
- """
- from backend.app.services.bambu_ftp import ftps_handshake_blocked
- ip_address = getattr(printer, "ip_address", None)
- if not ip_address:
- return True
- return not ftps_handshake_blocked(ip_address)
- async def _list_timelapse_videos(printer) -> tuple[list[dict], str | None]:
- """List video files from printer's timelapse directory.
- Finds MP4 (X1/A1 series) and AVI (P1 series) timelapse files.
- Returns (video_files, found_path) where video_files is a list of file dicts
- and found_path is the directory where they were found, or ([], None).
- An empty return does not distinguish "no videos" from "could not read the
- card" — see :func:`_timelapse_listing_is_trustworthy`, which the two
- baseline callers consult before believing one.
- """
- from backend.app.services.bambu_ftp import list_files_async
- logger = logging.getLogger(__name__)
- # No card in the slot means no /timelapse to walk — four connections that
- # can only fail, on a path whose failures are swallowed and so would go on
- # costing time silently forever (#2780).
- #
- # ``getattr`` rather than ``printer.id``: every dereference below happens
- # inside the loop's own try/except, so a caller that passed something
- # unexpected used to get an empty listing rather than an exception. Keep
- # that, instead of making this gate the first thing that can raise here.
- printer_id = getattr(printer, "id", None)
- if printer_id is not None and not external_storage_present(printer_manager.get_status(printer_id)):
- logger.debug("[TIMELAPSE] Skipping the scan for printer %s: it reports no external storage", printer_id)
- return [], None
- for timelapse_path in ["/timelapse", "/timelapse/video", "/record", "/recording"]:
- try:
- found_files = await list_files_async(
- printer.ip_address, printer.access_code, timelapse_path, printer_model=printer.model
- )
- if found_files:
- video_files = [
- f
- for f in found_files
- if not f.get("is_directory") and f.get("name", "").lower().endswith(_TIMELAPSE_VIDEO_EXTENSIONS)
- ]
- if video_files:
- return video_files, timelapse_path
- except Exception as e:
- logger.debug("[TIMELAPSE] Path %s failed: %s", timelapse_path, e)
- continue
- return [], None
- async def _capture_timelapse_baseline_at_start(
- printer, printer_id: int, logger: logging.Logger, archive_id: int | None = None
- ) -> None:
- """Snapshot the printer's timelapse directory at print start so the
- completion-time scan can pick the new file by set-difference.
- Must be called from every on_print_start path that proceeds to a real
- print — both the new-archive branch and the expected-archive branch (which
- queue / VP-dispatched prints take). Without a baseline,
- _scan_for_timelapse_with_retries falls into its "take baseline now"
- fallback that runs AFTER the new MP4 has already landed on the SD card,
- so the new file ends up in the "baseline" set and no diff ever matches.
- Bambu printers in LAN-only mode don't sync NTP, so mtime ordering is
- unreliable — the snapshot-diff approach sidesteps that entirely.
- When ``archive_id`` is known the baseline is also written to the archive
- row, so it survives a restart and the manual "Scan for Timelapse" button
- can run the same diff instead of falling back to clock-based matching
- (#2704). Only baselines taken at print start are persisted — one taken at
- completion already contains the new video and would poison a later scan.
- """
- names: set[str] | None = None
- try:
- if not _timelapse_listing_is_trustworthy(printer):
- # Recorded anyway, deliberately. An empty baseline taken off a card
- # we could not read is not authoritative, but it is still the right
- # *default*: Bambuddy deletes each video from the printer once it is
- # attached, so the usual card holds exactly one video at completion
- # and an empty baseline resolves it correctly. Persisting NULL
- # instead would send completion to take its own snapshot, by which
- # point this print's video is on the card and would be swallowed by
- # it. The ambiguity is handled where it actually bites — see
- # ``require_unambiguous`` in the scan (#2957 follow-up).
- logger.warning(
- "[TIMELAPSE] Baseline for printer %s taken while its file service is in the FTPS "
- "handshake cool-off, so the card could not be read — treating it as empty",
- printer_id,
- )
- baseline_files, _ = await _list_timelapse_videos(printer)
- names = {f.get("name", "") for f in baseline_files}
- _timelapse_baselines[printer_id] = names
- logger.info(
- "[TIMELAPSE] Baseline at print start: %s video files for printer %s",
- len(names),
- printer_id,
- )
- except Exception as e:
- logger.warning("[TIMELAPSE] Failed to capture baseline at print start: %s", e)
- if archive_id is None:
- return
- try:
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- archive = await db.get(PrintArchive, archive_id)
- if archive is not None:
- # Written even when the listing failed, and then as NULL. A
- # reprint reuses the archive row, so leaving the previous run's
- # baseline in place would have the scan diff this print against
- # the state of the printer before the *last* one — and a stale
- # baseline reads as authoritative, where NULL correctly falls
- # back to a fresh snapshot.
- archive.timelapse_baseline = sorted(names) if names is not None else None
- await db.commit()
- except Exception as e:
- # In-memory baseline still covers the normal completion path.
- logger.warning("[TIMELAPSE] Failed to persist baseline for archive %s: %s", archive_id, e)
- async def _scan_for_timelapse_with_retries(archive_id: int, baseline_names: set[str] | None = None):
- """Poll the printer for this print's timelapse and attach it.
- Snapshot diff, not timestamp matching: a printer in LAN-only mode cannot
- reach Bambu's NTP server, so the clock behind both the filename and the FTP
- mtime is arbitrarily wrong — one reporter's P1S was six and a half days out
- (#2704). Comparing the current listing against the set of filenames that
- existed when the print started needs no clock at all, because the printer
- writes the video only once the print has ended.
- Baseline precedence: the caller's in-memory set, then the one persisted on
- the archive at print start, then a snapshot taken now. The last of those is
- a poor substitute — by completion the new video may already be on the card,
- in which case it lands in the "baseline" and no diff can ever match — but it
- is all that is available for a print that began before Bambuddy started.
- On success the video is deleted from the printer, which keeps ``/timelapse``
- down to the unclaimed files and makes the next diff unambiguous.
- """
- logger = logging.getLogger(__name__)
- # Cleared when the baseline had to be taken off a card we could not read, so
- # the attach step refuses to choose between several candidates (#2957).
- baseline_trusted = True
- # --- Phase 1: establish the baseline -------------------------------------
- try:
- async with async_session() as db:
- from backend.app.models.printer import Printer
- service = ArchiveService(db)
- archive = await service.get_archive(archive_id)
- if not archive:
- logger.warning("[TIMELAPSE] Archive %s not found, aborting", archive_id)
- return
- if archive.timelapse_path:
- logger.info("[TIMELAPSE] Archive %s already has timelapse attached", archive_id)
- return
- if not archive.printer_id:
- logger.warning("[TIMELAPSE] Archive %s has no printer, aborting", archive_id)
- return
- if baseline_names is not None:
- logger.info(
- "[TIMELAPSE] Using print-start baseline: %s existing video files for archive %s",
- len(baseline_names),
- archive_id,
- )
- elif archive.timelapse_baseline is not None:
- # Persisted at print start — survives a restart mid-print.
- baseline_names = set(archive.timelapse_baseline)
- logger.info(
- "[TIMELAPSE] Using stored baseline: %s existing video files for archive %s",
- len(baseline_names),
- archive_id,
- )
- else:
- result = await db.execute(select(Printer).where(Printer.id == archive.printer_id))
- printer = result.scalar_one_or_none()
- if not printer:
- logger.warning("[TIMELAPSE] Printer not found for archive %s, aborting", archive_id)
- return
- if not _timelapse_listing_is_trustworthy(printer):
- # The card is unreadable at the one moment a baseline has to
- # be taken, so the empty listing below means "we never
- # looked", not "these are all new". Carry on with it anyway
- # — the usual card holds exactly one video, which resolves
- # correctly — but stop the poll from *choosing* between
- # several, which is how a stale video got attached to this
- # print and then deleted off the printer (#2957 follow-up).
- baseline_trusted = False
- logger.warning(
- "[TIMELAPSE] Baseline for archive %s taken while printer %s is in the FTPS "
- "handshake cool-off. A single new video still resolves; several will not be "
- "guessed between — use Scan for Timelapse to pick one by hand",
- archive_id,
- archive.printer_id,
- )
- baseline_files, _ = await _list_timelapse_videos(printer)
- baseline_names = {f.get("name", "") for f in baseline_files}
- logger.info(
- "[TIMELAPSE] Baseline snapshot (fallback): %s existing video files for archive %s",
- len(baseline_names),
- archive_id,
- )
- except Exception as e:
- logger.warning("[TIMELAPSE] Failed to take baseline snapshot for archive %s: %s", archive_id, e)
- return
- # --- Phase 2: poll for a file that was not there when the print began -----
- deadline = time.monotonic() + _TIMELAPSE_SCAN_TIMEOUT_SECONDS
- max_attempts = _timelapse_scan_max_attempts()
- seen_names: set[str] = set()
- delay = _TIMELAPSE_SCAN_FIRST_DELAY_SECONDS
- attempt = 0
- while True:
- await asyncio.sleep(delay)
- delay = _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS
- attempt += 1
- try:
- from backend.app.models.printer import Printer
- # Read phase: fetch archive + printer in a short session and release
- # the pooled connection BEFORE the FTP list/download below. Holding it
- # across the FTP round-trips left one connection idle-in-transaction per
- # in-flight scan (issue #2572).
- async with async_session() as db:
- service = ArchiveService(db)
- archive = await service.get_archive(archive_id)
- if not archive:
- logger.warning("[TIMELAPSE] Archive %s not found, stopping poll", archive_id)
- return
- if archive.timelapse_path:
- logger.info("[TIMELAPSE] Archive %s already has timelapse attached, stopping poll", archive_id)
- return
- result = await db.execute(select(Printer).where(Printer.id == archive.printer_id))
- printer = result.scalar_one_or_none()
- if not printer:
- logger.warning("[TIMELAPSE] Printer not found for archive %s, stopping poll", archive_id)
- return
- claimed = await _claimed_timelapse_names(db, archive.printer_id, archive_id)
- # I/O phase (no DB connection held): FTP list + download.
- video_files, found_path = await _list_timelapse_videos(printer)
- # The poll can run for dozens of rounds, so only narrate a round
- # that saw something change. Repeating the whole listing every 30 s
- # would bury the one interesting line in the support bundle.
- names_now = {f.get("name", "") for f in video_files}
- changed = attempt == 1 or names_now != seen_names
- seen_names = names_now
- speak = logger.info if changed else logger.debug
- if video_files:
- speak("[TIMELAPSE] Attempt %s: Found %s video files in %s", attempt, len(video_files), found_path)
- if changed:
- for f in video_files[:5]:
- logger.info("[TIMELAPSE] - %s", f.get("name"))
- attached = await _attach_first_unclaimed_timelapse(
- archive_id,
- printer,
- video_files,
- baseline_names,
- claimed,
- attempt,
- logger,
- quiet=not changed,
- require_unambiguous=not baseline_trusted,
- )
- if attached:
- return
- else:
- speak("[TIMELAPSE] Attempt %s: No video files found, will retry", attempt)
- except Exception as e:
- logger.warning("[TIMELAPSE] Attempt %s failed with error: %s", attempt, e)
- if attempt >= max_attempts or time.monotonic() >= deadline:
- break
- # No name-match fallback: it compared the print name against the filename,
- # and Bambu firmware only ever writes "video_<timestamp>". Across 247 support
- # bundles it fired 159 times and matched zero times, so all it added was a
- # misleading log line before giving up.
- logger.warning(
- "[TIMELAPSE] No new video appeared for archive %s within %ss, giving up",
- archive_id,
- int(_TIMELAPSE_SCAN_TIMEOUT_SECONDS),
- )
- async def _attach_first_unclaimed_timelapse(
- archive_id: int,
- printer,
- video_files: list[dict],
- baseline_names: set[str],
- claimed: set[str],
- attempt: int,
- logger: logging.Logger,
- *,
- quiet: bool = False,
- require_unambiguous: bool = False,
- ) -> bool:
- """Download and attach the one video that belongs to this print.
- A candidate is any file absent from the print-start baseline. More than one
- can qualify when a previous print's video landed late, after this print's
- baseline was taken — those are filtered out by name, because they are
- already attached to another archive. Sorting the candidates instead would
- mean sorting on mtime or on the filename timestamp, both of which come from
- the printer's unsynced clock.
- Returns True once a video is attached. The printer's copy is deleted only
- after the attach succeeds on bytes whose length matched the listing.
- ``quiet`` downgrades the "nothing yet" lines to DEBUG when the caller has
- already seen this exact listing — the poll runs for many rounds and only the
- rounds where something changed are worth an INFO line.
- """
- from backend.app.services.bambu_ftp import (
- delete_archived_timelapse,
- download_file_bytes_async,
- remote_file_settled,
- )
- speak = logger.debug if quiet else logger.info
- new_files = [f for f in video_files if f.get("name", "") not in baseline_names]
- if not new_files:
- speak("[TIMELAPSE] Attempt %s: No new files since baseline, will retry", attempt)
- return False
- candidates = [f for f in new_files if Path(f.get("name", "")).stem not in claimed]
- if not candidates:
- speak(
- "[TIMELAPSE] Attempt %s: %s new file(s), all already attached to other archives, will retry",
- attempt,
- len(new_files),
- )
- return False
- if len(candidates) > 1:
- if require_unambiguous:
- # The baseline is not evidence -- it was taken off a card that could
- # not be read -- so "new since the baseline" does not narrow these
- # down at all. Taking the first would attach an arbitrary video to
- # this print and then delete it from the printer.
- logger.warning(
- "[TIMELAPSE] Attempt %s: %s unclaimed videos (%s) and no baseline to tell them apart — "
- "leaving all of them on the printer for manual selection",
- attempt,
- len(candidates),
- ", ".join(str(f.get("name")) for f in candidates),
- )
- return False
- logger.warning(
- "[TIMELAPSE] Attempt %s: %s unclaimed new files (%s) — taking the first; "
- "the rest stay on the printer for manual selection",
- attempt,
- len(candidates),
- ", ".join(str(f.get("name")) for f in candidates),
- )
- target = candidates[0]
- file_name = target.get("name")
- remote_path = target.get("path") or f"/timelapse/{file_name}"
- logger.info(
- "[TIMELAPSE] Attempt %s: New file detected: %s (downloading for archive %s)",
- attempt,
- file_name,
- archive_id,
- )
- # The listing always carries a size (`list_files` skips entries it can't
- # parse), but read it explicitly: the delete below is destructive and must
- # depend on a size we actually had, not on one we hoped was there.
- expected_size = target.get("size")
- timelapse_data = await download_file_bytes_async(
- printer.ip_address,
- printer.access_code,
- remote_path,
- printer_model=printer.model,
- expected_size=expected_size,
- )
- if not timelapse_data:
- # Short or failed transfer. The printer keeps its copy, so the next
- # round can try again — which is exactly why the delete below is
- # gated on a verified download.
- logger.warning("[TIMELAPSE] Attempt %s: Failed to download new file, will retry", attempt)
- return False
- # The length check above proves we got what the listing said, not that the
- # printer had finished writing. A video still being written can be listed
- # short, served short, and pass — so confirm it has stopped growing before
- # committing to it and deleting the original (#2704).
- if not await remote_file_settled(
- printer.ip_address,
- printer.access_code,
- remote_path,
- len(timelapse_data),
- printer_model=printer.model,
- ):
- return False
- # Write phase: attach in a fresh short-lived session.
- async with async_session() as db:
- success = await ArchiveService(db).attach_timelapse(archive_id, timelapse_data, file_name)
- if not success:
- logger.warning("[TIMELAPSE] Failed to attach timelapse to archive %s", archive_id)
- return False
- logger.info("[TIMELAPSE] Successfully attached timelapse to archive %s", archive_id)
- await ws_manager.send_archive_updated({"id": archive_id, "timelapse_attached": True})
- await delete_archived_timelapse(
- printer.ip_address,
- printer.access_code,
- remote_path,
- verified=expected_size is not None,
- printer_model=printer.model,
- printer_name=printer.name,
- )
- return True
- # Defaults for the finish-photo-from-timelapse polling loop (#1397). These are
- # module-level so tests can monkeypatch them down to ~0 without timing out.
- _FINISH_PHOTO_TIMELAPSE_POLL_INTERVAL_SECONDS: float = 3.0
- _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS: float = 60.0
- # How long the *background* upgrade keeps waiting after the notification has
- # already gone out (#2704 follow-up). The short bound above exists so a slow
- # printer can't hold up the print-complete notification; this one exists so the
- # archive still ends up with the better frame afterwards.
- #
- # Measured across 261 attaches in the support bundles, the video lands a median
- # 13s after the print ends — but the P1 series writes MJPEG AVI rather than
- # H.264 MP4 and serves it slowly, so its p90 is 167s and the worst observed case
- # was 546s. Every other model was inside 26s. The long budget is therefore
- # almost entirely for P1-series users; on everything else the short wait already
- # wins and this task never runs.
- _FINISH_PHOTO_UPGRADE_TIMEOUT_SECONDS: float = 900.0
- async def _capture_finish_photo_from_timelapse(
- archive_id: int,
- archive_dir: Path,
- timeout: float | None = None,
- rotation: int = 0,
- ) -> tuple[str | None, bool]:
- """Wait for the per-print timelapse to land on the archive and extract its
- last frame as the finish photo (#1397).
- Bambu firmware stops timelapse recording after the toolhead parks but
- before the bed-drop end-gcode runs, so the last frame frames the finished
- print correctly. A live camera grab at gcode_state=FINISH captures the
- bed already lowered.
- ``_scan_for_timelapse_with_retries`` runs in parallel and writes
- ``archive.timelapse_path`` when the file lands. This function polls for
- that field.
- Returns ``(filename, still_pending)``. ``still_pending`` is True only when
- the wait ran out with no video on the archive yet — i.e. the video may
- still be coming and a later attempt could succeed. It is False when the
- video landed (whether or not extraction worked), because in that case
- waiting longer changes nothing. The caller uses that to decide between
- falling back permanently and scheduling a background upgrade.
- ``rotation`` is the printer's camera_rotation, applied to the extracted
- still (#2708) so this source agrees with every other finish-photo source.
- The archived video itself is the printer's own file and is left alone —
- rotating it would mean re-encoding it.
- """
- import uuid
- from backend.app.models.archive import PrintArchive
- from backend.app.services.camera import apply_camera_rotation_to_file, extract_video_last_frame
- logger = logging.getLogger(__name__)
- budget = _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS if timeout is None else timeout
- deadline = asyncio.get_event_loop().time() + budget
- poll_interval = _FINISH_PHOTO_TIMELAPSE_POLL_INTERVAL_SECONDS
- while True:
- async with async_session() as db:
- result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
- archive = result.scalar_one_or_none()
- timelapse_relpath = archive.timelapse_path if archive else None
- if timelapse_relpath:
- video_path = app_settings.base_dir / timelapse_relpath
- if video_path.exists() and video_path.stat().st_size > 0:
- photos_dir = archive_dir / "photos"
- photos_dir.mkdir(parents=True, exist_ok=True)
- timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
- filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
- output_path = photos_dir / filename
- if await extract_video_last_frame(video_path, output_path):
- await apply_camera_rotation_to_file(output_path, rotation, logger)
- logger.info(
- "[PHOTO-BG] Extracted finish photo from timelapse %s for archive %s",
- video_path.name,
- archive_id,
- )
- return filename, False
- logger.warning(
- "[PHOTO-BG] Timelapse %s landed but last-frame extraction failed for archive %s; falling back",
- video_path.name,
- archive_id,
- )
- return None, False
- if asyncio.get_event_loop().time() >= deadline:
- logger.info(
- "[PHOTO-BG] Timelapse for archive %s didn't land within %.0fs; falling back to live camera",
- archive_id,
- budget,
- )
- return None, True
- await asyncio.sleep(poll_interval)
- async def _upgrade_finish_photo_from_timelapse(archive_id: int, archive_dir: Path, rotation: int = 0) -> None:
- """Add the timelapse's last frame to an archive after the fact (#2704).
- The print-complete notification waits only ~60s for the video, because
- holding a notification for minutes is worse than sending it with a live
- camera grab. On a P1-series printer the video often lands well after that,
- so the archive used to be stuck with the live grab — which is taken at
- ``gcode_state=FINISH``, after the end G-code has dropped the bed, and is
- the worse photo of the two.
- This keeps waiting in the background and, when the video arrives, extracts
- the frame and puts it *first* in the archive's photo list, so opening the
- gallery shows it. The live grab is deliberately kept: the notification that
- already went out links to that exact file, and deleting it would leave a
- broken image in Discord or Telegram.
- """
- logger = logging.getLogger(__name__)
- filename, _ = await _capture_finish_photo_from_timelapse(
- archive_id, archive_dir, timeout=_FINISH_PHOTO_UPGRADE_TIMEOUT_SECONDS, rotation=rotation
- )
- if not filename:
- logger.info("[PHOTO-UPGRADE] No timelapse frame for archive %s; keeping the live grab", archive_id)
- return
- try:
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- archive = await db.get(PrintArchive, archive_id)
- if archive is None:
- return
- photos = list(archive.photos or [])
- if filename in photos:
- return
- # Front of the list: PhotoGalleryModal opens at index 0.
- archive.photos = [filename, *photos]
- await db.commit()
- except Exception as e:
- logger.warning("[PHOTO-UPGRADE] Failed to attach upgraded photo to archive %s: %s", archive_id, e)
- return
- logger.info("[PHOTO-UPGRADE] Archive %s now leads with the timelapse frame %s", archive_id, filename)
- await ws_manager.send_archive_updated({"id": archive_id, "photo_added": filename})
- async def _restore_usage_tracking_session(printer_id: int, state, db, logger) -> None:
- """Put the filament-attribution context back after a restart mid-print.
- ``usage_tracker._active_sessions`` and ``PrinterState.tray_change_log``
- both die with the process. The print keeps running, so at completion the
- tracker would fall back to whatever the printer reports *now* — and AMS
- filament backup makes "now" the substitute tray, charging the whole print
- to the spool that only finished it.
- The persisted row is only trusted when its print name still matches what
- the printer says it is running: a row left behind by a completion we never
- saw must not attach itself to the next print.
- """
- try:
- from backend.app.api.routes.settings import get_setting
- from backend.app.services.usage_tracker import (
- clear_persisted_session,
- get_persisted_print_name,
- restore_session,
- )
- persisted_name = await get_persisted_print_name(db, printer_id)
- current_name = (state.subtask_name or "").strip()
- if persisted_name and current_name and persisted_name.strip() != current_name:
- logger.info(
- "[RESTART] Discarding stale print session for printer %s (%r != running %r)",
- printer_id,
- persisted_name,
- current_name,
- )
- await clear_persisted_session(db, printer_id)
- # Fall through to seeding: the print on the printer is real, it just
- # isn't the one the row described.
- persisted_log = None
- else:
- # Spoolman users get the tray-change log back but no in-memory
- # session — see ``on_print_start`` on why that dict is load-bearing
- # for the remain%-sync guard.
- _spoolman_on = await get_setting(db, "spoolman_enabled")
- persisted_log = await restore_session(
- db,
- printer_id,
- register_active=not (bool(_spoolman_on) and _spoolman_on.lower() == "true"),
- )
- if persisted_log:
- restored = [tuple(entry) for entry in persisted_log if isinstance(entry, (list, tuple)) and len(entry) == 2]
- # Anything this process already observed goes after the persisted
- # history — the log is ordered by layer, and a fresh process can
- # only have seen changes from later in the print.
- for entry in state.tray_change_log or []:
- if tuple(entry) not in restored:
- restored.append(tuple(entry))
- state.tray_change_log = restored
- tray_now = state.tray_now
- if 0 <= tray_now <= 254:
- if not state.tray_change_log:
- # No persisted history — a print that started before this build,
- # or before the row existed. Seed with the tray feeding right
- # now so the remainder of the print is at least attributable to
- # the right spool.
- state.tray_change_log = [(tray_now, state.layer_num)]
- logger.info(
- "[RESTART] Seeded tray change log for printer %s: tray=%d at layer=%d",
- printer_id,
- tray_now,
- state.layer_num,
- )
- # The tray handler updates ``last_loaded_tray`` on every push
- # regardless of whether it logged a change, so re-align it to avoid
- # a duplicate entry on the next push. Only ever with a real tray:
- # ``last_loaded_tray`` is the "survives the end-of-print retract to
- # 255" fallback, and writing 255 into it would defeat that.
- state.last_loaded_tray = tray_now
- except Exception:
- # Never let attribution recovery cost the caller its timelapse
- # baseline — that capture has to happen before the printer uploads
- # the in-flight MP4 and there is no second chance at it.
- logger.exception("[RESTART] Failed to restore usage-tracking session for printer %s", printer_id)
- async def on_print_running_observed(printer_id: int, data: dict):
- """Restart-recovery for a print that started before Bambuddy came up.
- bambu_mqtt.py suppresses ``on_print_start`` on the first RUNNING push
- after Bambuddy startup (#1304 guard, prevents duplicate archive
- creation). This hook restores the persisted archive into ``_active_prints``
- and captures the timelapse baseline that normally hangs off print start.
- Fires once per session, in lieu of on_print_start when restart-recovery
- kicks in. The printer doesn't upload the timelapse until after PRINT
- COMPLETE, so a baseline captured any time during the print is still
- pre-upload.
- """
- logger = logging.getLogger(__name__)
- async with async_session() as db:
- from backend.app.models.printer import Printer
- state = printer_manager.get_status(printer_id)
- if state is not None:
- authorization = await _is_bambuddy_authorized_print(printer_id, state, db)
- if authorization is True:
- logger.info("[RESTART] Restored active Bambuddy print for printer %s", printer_id)
- await _restore_usage_tracking_session(printer_id, state, db, logger)
- await _restore_printable_objects(printer_id, state, db, logger)
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if not printer:
- logger.warning(
- "[TIMELAPSE] on_print_running_observed: printer %s not found in DB, skipping baseline",
- printer_id,
- )
- return
- # Avoid double-capture: ownership reconciliation above must still run when
- # a baseline already exists, but the camera work itself is one-shot.
- if printer_id in _timelapse_baselines:
- logger.debug(
- "[TIMELAPSE] on_print_running_observed: baseline already present for printer %s, skipping",
- printer_id,
- )
- return
- await _capture_timelapse_baseline_at_start(printer, printer_id, logger)
- def _is_active_archive_stale(archive, state) -> tuple[bool, str]:
- """Return ``(is_stale, reason)`` for an archive in ``status="printing"``
- against the printer's current MQTT state.
- Reconciliation triggers (#1542 follow-up — recovers from missed PRINT
- COMPLETE events, typically a print finishing during an MQTT disconnect
- window followed by a smart-plug power cycle):
- 1. Printer state is terminal (IDLE / FINISH / FAILED). The print is
- provably not running anymore — only branch that should fire under
- normal disconnect-then-reconnect timing.
- 2. Printer has a different ``subtask_id`` than the archive. Bambu
- firmware mints a fresh ``subtask_id`` for each print, including the
- ghost replay it runs after a power cycle from a leftover SD file —
- so a mismatch unambiguously means the in-DB archive is no longer
- the print on the printer.
- 3. Printer is running but ``subtask_name`` is empty. The printer
- doesn't know what it's running; the archive's reference to it is
- already broken.
- Conservative on purpose: PAUSE / PREPARE / SLICING and any RUNNING state
- with matching subtask_id+subtask_name is left alone. The cost of a false
- positive is a duplicate archive on the next real PRINT COMPLETE — the
- reactive handler uses ``_active_prints`` for lookup, which the reconcile
- clears on synthesis, so the real completion creates a fresh row instead
- of overwriting the synthesised one (#1679). The cost of a false negative
- is the ghost-print loop in #1542.
- Pre-push guard (#1679): when ``state.state`` is empty or ``"unknown"``,
- MQTT has connected but the first ``push_status`` response hasn't been
- applied yet — ``PrinterState`` is sitting on its construction defaults.
- The reconcile caller in ``on_printer_status_change`` is already gated
- on a real ``state.state``, so in normal operation this branch is
- unreachable; it's kept as belt-and-braces for future callers and for
- the narrow window where a partial state update could arrive
- (``state.state`` set but ``subtask_name`` not yet populated). Returning
- ``not stale`` on degenerate input is strictly conservative: a real
- stale archive will still be caught by the next push_status arriving
- with terminal state.
- """
- current_state = (state.state or "").upper()
- if current_state in ("", "UNKNOWN"):
- # No real push_status yet — PrinterState defaults are not evidence.
- return False, ""
- if current_state in ("IDLE", "FINISH", "FAILED"):
- return True, f"printer state {current_state}"
- # Below here the printer is in a running / pre-running state (RUNNING /
- # PAUSE / PREPARE / SLICING / etc.) — decide based on subtask identity.
- current_subtask_id = (state.subtask_id or "").strip()
- if archive.subtask_id and current_subtask_id and archive.subtask_id != current_subtask_id:
- return True, f"subtask_id changed ({archive.subtask_id!r} → {current_subtask_id!r})"
- current_subtask_name = (state.subtask_name or "").strip()
- if not current_subtask_name:
- return True, "printer subtask_name empty"
- return False, ""
- async def prime_kprofile_table(printer_id: int) -> int:
- """Read the printer's calibration table once per connection.
- The AMS slot card shows a K value per slot (#2854). On the printers whose
- trays carry no ``k`` field of their own -- the whole H2 series, whose trays
- report ``cali_idx`` and nothing else -- that number can only come from
- ``state.kprofiles``, and nothing used to fill it on connect. It arrived by
- luck: someone opening the Profiles page or Configure Slot, a nightly GitHub
- backup, or the printer answering a query BambuStudio made on the report
- topic we share. A Bambuddy that nobody visited showed a card with no K
- values at all.
- Only the diameters actually fitted are asked for, which is one request on a
- single-nozzle printer and two on a dual. Probing the four sizes blind is
- what the backup does, and it is both wasteful and the thing that used to
- blank the table.
- Returns the number of nozzles whose table was read.
- """
- client = printer_manager.get_client(printer_id)
- state = printer_manager.get_status(printer_id)
- if client is None or state is None or not state.connected:
- return 0
- # Deduplicated, order preserved: a dual-nozzle printer with two 0.4s should
- # ask once, and both entries are empty until the first push_status lands.
- diameters = list(dict.fromkeys(n.nozzle_diameter for n in (state.nozzles or []) if n.nozzle_diameter))
- if not diameters:
- logging.getLogger(__name__).debug(
- "[Printer %s] No nozzle diameter reported yet; leaving the K-profile table to the next reader",
- printer_id,
- )
- return 0
- primed = 0
- for diameter in diameters:
- try:
- profiles = await client.get_kprofiles(nozzle_diameter=diameter, max_retries=2)
- except Exception as exc: # noqa: BLE001
- # A printer that won't answer costs the card its K values, nothing
- # more — never the connection this runs on the back of.
- logging.getLogger(__name__).warning(
- "[Printer %s] Could not read the K-profile table for nozzle %s: %s", printer_id, diameter, exc
- )
- continue
- primed += 1
- logging.getLogger(__name__).info(
- "[Printer %s] Primed K-profile table for nozzle %s: %d profiles", printer_id, diameter, len(profiles)
- )
- return primed
- async def reconcile_stale_active_prints(printer_id: int) -> int:
- """Synthesise ``on_print_complete`` for archives whose print can't be
- running on the printer anymore.
- Called once per MQTT (re)connection (from on_printer_status_change when
- the connected edge flips False → True) and at Bambuddy startup (from
- the FastAPI lifespan). Without this, a print that completes during a
- disconnect window — followed by a smart-plug-driven power cycle — leaves
- the ``.3mf`` on the SD card, the firmware auto-replays it on next boot,
- and Bambuddy fires a fresh PRINT START for the ghost rather than the
- SD cleanup that PRINT COMPLETE was supposed to run. Repeats every
- power cycle until the operator notices (#1542 follow-up). Reconciliation
- closes the loop by faking the missed PRINT COMPLETE — the existing
- cleanup chain handles SD-file deletion, status updates, usage tracking,
- and notifications.
- Synthesised ``status="aborted"`` is the conservative label: we have no
- proof the print finished successfully (and no progress evidence to
- promote to ``"completed"``). The real PRINT COMPLETE callback, if it
- fires later, overwrites the status with the correct value.
- Returns the number of archives reconciled.
- """
- state = printer_manager.get_status(printer_id)
- if not state:
- return 0
- # Don't reconcile while disconnected — we'd be making a decision against
- # stale cached state. The connected → reconcile edge handles this.
- if not state.connected:
- return 0
- from backend.app.models.archive import PrintArchive
- reconciled = 0
- async with async_session() as db:
- result = await db.execute(
- select(PrintArchive).where(
- PrintArchive.printer_id == printer_id,
- PrintArchive.status == "printing",
- )
- )
- active = list(result.scalars().all())
- if not active:
- return 0
- logger = logging.getLogger(__name__)
- for archive in active:
- is_stale, reason = _is_active_archive_stale(archive, state)
- if not is_stale:
- continue
- logger.info(
- "[RECONCILE] Printer %s: synthesising missed PRINT COMPLETE for archive %s (%s) — %s",
- printer_id,
- archive.id,
- archive.filename,
- reason,
- )
- # Synthesised payload: minimal fields the on_print_complete chain
- # needs. `_reconciled` marker lets downstream code distinguish this
- # from a real MQTT-driven completion if it ever needs to (e.g. for
- # metrics / debug logging). raw_data is the live printer state so
- # the usage tracker can compare end-of-print remain% against the
- # captured start values.
- try:
- await on_print_complete(
- printer_id,
- {
- "status": "aborted",
- "filename": archive.filename,
- "subtask_name": archive.print_name or "",
- "subtask_id": archive.subtask_id or "",
- "raw_data": state.raw_data or {},
- "_reconciled": True,
- },
- )
- reconciled += 1
- except Exception as e:
- # Catch-all: a reconciliation failure must not block the
- # printer's normal status flow. The archive stays in
- # ``status="printing"`` and the next reconnect retries.
- logger.warning(
- "[RECONCILE] on_print_complete synthesis failed for archive %s: %s",
- archive.id,
- e,
- )
- return reconciled
- # #2547: clearance left between the nozzle and the top of the print when the
- # plate is commanded back into camera framing. The nozzle is parked away from
- # the part by then, so this is belt-and-braces against a max_z_height that
- # under-reports (e.g. a slicer that excludes a final Z hop).
- _PLATE_RESTORE_CLEARANCE_MM = 10.0
- # How far below the restored position to drop the plate again afterwards, so
- # the print is as reachable as Bambu's own end G-code leaves it. Matches the
- # stock `G1 Z{max_layer_z + 100}`; the firmware clamps it to the travel limit
- # on machines with less headroom.
- _PLATE_PARK_DROP_MM = 100.0
- # Feedrate for both moves. F600 is exactly what Bambu's own end G-code uses on
- # this axis, so it is a proven-safe speed for the full travel.
- _PLATE_RESTORE_FEEDRATE = 600
- # Time allowed for the plate to reach the restored position before the camera
- # grab. Sized for the ~100 mm the stock end G-code drops at F600 (10 mm/s).
- _PLATE_RESTORE_SETTLE_SECONDS = 12.0
- # How long `_background_finish_photo` waits for this producer. Must cover the
- # settle window plus a worst-case RTSP grab (15s), and stay below the
- # notification path's own photo wait so a slow producer degrades to a
- # photo-less notification rather than a missed one.
- _FINISH_PHOTO_PRODUCER_WAIT_SECONDS = _PLATE_RESTORE_SETTLE_SECONDS + 23.0
- async def _max_z_for_current_print(printer_id: int, data: dict, logger) -> float | None:
- """Height of the print that just finished on ``printer_id``, or None (#2547).
- This number becomes the target of a real Z move, so every step here refuses
- rather than guesses. A height belonging to some *other* print is the one
- failure that could drive the nozzle into the model: 20 mm carried onto a
- 200 mm print would command the plate up through the part.
- Two independent things therefore have to agree before a height is returned:
- 1. **Identity.** The archive is matched by the finished print's own
- ``subtask_name``, by equality rather than a ``LIKE``, so "Cube" can never
- resolve to "Cube v2". Matching on "most recent archive for this printer"
- is not good enough — ``on_print_complete`` pops the ``_active_prints``
- binding concurrently with us, and a print Bambuddy failed to archive
- would silently resolve to its predecessor.
- 2. **Corroboration.** The archive's layer count (parsed from the 3MF) has to
- match the layer count the printer itself reported over MQTT for the print
- that just ended. These come from genuinely different sources, so a
- mismatch means the row is not this print, whatever its name says.
- ``completed`` is accepted alongside ``printing`` only because
- ``on_print_complete`` may already have flipped the status by the time we
- run; the identity check above is what actually selects the row.
- """
- subtask_name = (data.get("subtask_name") or "").strip()
- if not subtask_name:
- # Nothing to identify the print by — refuse rather than fall back to
- # "whatever ran last on this printer".
- logger.info("[PLATE-RESTORE] printer %s: print has no name to match on — skipping", printer_id)
- return None
- try:
- from backend.app.models.archive import PrintArchive
- from backend.app.utils.threemf_tools import extract_max_z_height_from_3mf
- async with async_session() as db:
- result = await db.execute(
- select(PrintArchive)
- .where(
- PrintArchive.printer_id == printer_id,
- PrintArchive.status.in_(("printing", "completed")),
- PrintArchive.deleted_at.is_(None),
- or_(
- PrintArchive.print_name == subtask_name,
- PrintArchive.filename == subtask_name,
- PrintArchive.filename == f"{subtask_name}.3mf",
- PrintArchive.filename == f"{subtask_name}.gcode.3mf",
- ),
- )
- .order_by(PrintArchive.id.desc())
- .limit(1)
- )
- archive = result.scalar_one_or_none()
- if archive is None or not archive.file_path:
- logger.info("[PLATE-RESTORE] printer %s: no archive matches %r — skipping", printer_id, subtask_name)
- return None
- client = printer_manager.get_client(printer_id)
- reported_layers = getattr(getattr(client, "state", None), "total_layers", None)
- if reported_layers and archive.total_layers and reported_layers != archive.total_layers:
- logger.warning(
- "[PLATE-RESTORE] printer %s: archive %s says %s layers but the printer reported %s "
- "— refusing to move the plate on a height that may not be this print's",
- printer_id,
- archive.id,
- archive.total_layers,
- reported_layers,
- )
- return None
- path = Path(archive.file_path)
- if not path.is_absolute():
- path = Path(app_settings.data_dir) / path
- return await asyncio.to_thread(extract_max_z_height_from_3mf, path, archive.plate_id or 1)
- except Exception as e:
- logger.debug("[PLATE-RESTORE] printer %s: no usable print height: %s", printer_id, e)
- return None
- async def _restore_plate_for_finish_photo(printer_id: int, max_z_height: float, logger) -> bool:
- """Raise the plate back into camera framing before the finish photo (#2547).
- Bambu's end G-code drops the plate ~100 mm as the last thing it does, so by
- the time ``gcode_state`` reaches FINISH the finished print sits far below
- the camera's natural framing — the complaint behind #1145, #1397 and #1565.
- This commands an absolute ``G1 Z`` back to just above the last printed
- layer.
- Absolute, not relative, is the whole safety argument. ``max_z_height +
- clearance`` is a height the toolhead was physically at seconds earlier, so
- it is inside the travel limits by construction and leaves the nozzle above
- the part. It is also unambiguous across model families: Z is the
- nozzle-to-bed gap whether the bed moves (X1/P1/H2) or the toolhead does
- (A1), so unlike the relative bed-jog path (#1334) there is no sign to get
- wrong. ``M211`` is never touched — see the bed-jog docstring for why
- (#2579).
- Returns True if the move was sent and waited out, False if it was skipped.
- """
- client = printer_manager.get_client(printer_id)
- if client is None:
- return False
- # Re-read state immediately before commanding motion. If the queue has
- # already started the next print, the printer is no longer ours to move.
- state = getattr(client, "state", None)
- if state is None or state.state != "FINISH":
- logger.info(
- "[PLATE-RESTORE] printer %s is in state %s, not FINISH — skipping",
- printer_id,
- getattr(state, "state", "unknown"),
- )
- return False
- target_z = max_z_height + _PLATE_RESTORE_CLEARANCE_MM
- if not client.send_gcode(f"G90\nG1 Z{target_z:.2f} F{_PLATE_RESTORE_FEEDRATE}"):
- logger.warning("[PLATE-RESTORE] printer %s: send failed — capturing where it is", printer_id)
- return False
- logger.info(
- "[PLATE-RESTORE] printer %s: plate to Z%.2f (print top %.2f + %.1f clearance), settling %.0fs",
- printer_id,
- target_z,
- max_z_height,
- _PLATE_RESTORE_CLEARANCE_MM,
- _PLATE_RESTORE_SETTLE_SECONDS,
- )
- await asyncio.sleep(_PLATE_RESTORE_SETTLE_SECONDS)
- return True
- def _park_plate_after_finish_photo(printer_id: int, max_z_height: float, logger) -> None:
- """Drop the plate again after the finish photo (#2547).
- Without this the user walks up to a finished print sitting just under the
- nozzle, which is exactly the position Bambu's end G-code goes out of its way
- to avoid — awkward to lift the plate out, and easy to knock the toolhead.
- Fire-and-forget: if it doesn't land, the plate is merely high, and the next
- print homes anyway.
- """
- client = printer_manager.get_client(printer_id)
- state = getattr(client, "state", None) if client else None
- if client is None or state is None or state.state != "FINISH":
- return
- client.send_gcode(f"G90\nG1 Z{max_z_height + _PLATE_PARK_DROP_MM:.2f} F{_PLATE_RESTORE_FEEDRATE}")
- logger.debug("[PLATE-RESTORE] printer %s: plate returned to unload height", printer_id)
- async def _plate_restore_is_blocked_by_queue(printer_id: int) -> bool:
- """True if a queue item is about to take this printer (#2547).
- The scheduler dispatches the next job the moment a print completes, and a
- plate move interleaved with a print start is not a race worth having. The
- state re-check in ``_restore_plate_for_finish_photo`` closes the tail of
- this window; this closes the head of it.
- """
- try:
- from backend.app.models.print_queue import PrintQueueItem
- async with async_session() as db:
- result = await db.execute(
- select(PrintQueueItem.id)
- .where(
- PrintQueueItem.printer_id == printer_id,
- PrintQueueItem.status.in_(("pending", "printing")),
- )
- .limit(1)
- )
- return result.scalar_one_or_none() is not None
- except Exception as e:
- # Fail closed: if we can't tell, don't move the plate.
- logging.getLogger(__name__).debug(
- "[PLATE-RESTORE] queue check failed for printer %s: %s — skipping restore", printer_id, e
- )
- return True
- async def on_finish_photo_moment(printer_id: int, data: dict):
- """Pre-capture a finish photo when the printer enters stage 22 / FINISH (#1721).
- Fires either at the stage-22 ("Filament unloading") edge — toolhead
- parked, bed not yet dropped, optimal framing — or as a FINISH-state
- fallback for prints that skip stage 22 (cancel, external-spool-only,
- HMS halt, firmware variants). Grabs one frame via the same
- external-camera / RTSP path the post-completion fallback uses, stores
- the JPEG bytes in ``_stage22_finish_frames[printer_id]``, and lets
- ``_background_finish_photo`` consume the cached bytes when it runs.
- Replaces the #1397 "force timelapse on at dispatch" mechanism, which
- caused per-layer nozzle parking on slicer profiles with Timelapse Type
- set to Smooth (#1721). No force-on now means the user's explicit
- timelapse=off in the slicer send dialog is respected.
- """
- logger = logging.getLogger(__name__)
- trigger = data.get("trigger", "unknown")
- timelapse_was_active = bool(data.get("timelapse_was_active"))
- logger.info(
- "[FINISH-PHOTO-MOMENT] printer=%s trigger=%s timelapse_active=%s",
- printer_id,
- trigger,
- timelapse_was_active,
- )
- # If a timelapse is actively recording, skip the pre-capture — the
- # post-completion path will extract the last frame from the recorded
- # video, which still provides the best framing (toolhead parked,
- # before bed drop) without the per-layer parking side effects.
- if timelapse_was_active:
- logger.info(
- "[FINISH-PHOTO-MOMENT] timelapse active for printer %s — skipping pre-capture (last-frame extraction will run post-completion)",
- printer_id,
- )
- return
- # #1790: register the producer-done event BEFORE the first await so the
- # consumer in `_background_finish_photo` — which is dispatched back-to-back
- # with us on the FINISH-state fallback path — sees it as soon as it polls.
- # The `finally` below guarantees `set()` runs on every exit, including
- # early returns and exceptions, so the consumer's bounded wait can't hang.
- producer_done = asyncio.Event()
- _stage22_finish_in_flight[printer_id] = producer_done
- # #2547: set once the plate has actually been raised, and read by the
- # `finally` below. Declared out here so a failure anywhere after the move —
- # a camera timeout, a DB error — still lowers the plate again.
- restore_max_z: float | None = None
- try:
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- from backend.app.models.printer import Printer
- capture_setting = await get_setting(db, "capture_finish_photo")
- if capture_setting is not None and capture_setting.lower() != "true":
- logger.info("[FINISH-PHOTO-MOMENT] capture_finish_photo disabled — skipping pre-capture")
- return
- restore_setting = await get_setting(db, "finish_photo_restore_plate")
- restore_plate_enabled = restore_setting is None or restore_setting.lower() == "true"
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if printer is None:
- logger.warning(
- "[FINISH-PHOTO-MOMENT] printer %s not found in DB",
- printer_id,
- )
- return
- frame_bytes: bytes | None = None
- # #2708: the banked frame arrives already rotated — it comes from
- # `_capture_snapshot_for_notification`, which rotates before returning.
- # Every other source below is a raw grab. Tracking which lets us store
- # exactly one rotation in `_stage22_finish_frames` either way.
- frame_already_rotated = False
- # On the FINISH-state path the End G-code has already run, and two very
- # different situations arrive here needing opposite answers.
- #
- # #1867: if Bambuddy injected End G-code into this print, a SwapMod
- # snippet may have ejected the plate — the scene in front of the camera
- # is no longer the finished print, and no amount of moving the plate
- # brings it back. Use the banked in-print frame instead.
- #
- # #2547: otherwise the print is still sitting there, just ~100 mm lower
- # than the camera frames well, and the toolhead is parked out of the
- # way. That is the *best* moment available on firmware that never emits
- # stage 22 (H2C, A1 Mini) — so capture live, after putting the plate
- # back. Preferring the bank here unconditionally, as this code used to,
- # is what shipped a mid-print photo with the toolhead over the part.
- if trigger == "finish_state" and print_dispatch_context.end_gcode_injected(printer_id):
- banked = _inprint_frame_bank.get(printer_id)
- if banked:
- frame_bytes = banked
- frame_already_rotated = True
- logger.info(
- "[FINISH-PHOTO-MOMENT] End G-code was injected — using banked in-print "
- "frame (%d bytes) instead of a post-swap live grab",
- len(banked),
- )
- else:
- logger.warning(
- "[FINISH-PHOTO-MOMENT] End G-code was injected for printer %s but the "
- "in-print bank is empty — falling back to a live grab, which may show a "
- "swapped or empty plate",
- printer_id,
- )
- # `restore_max_z` is set only once the plate is actually up, because the
- # `finally` reads it to decide whether it owes a move back down.
- #
- # Never on a print whose End G-code Bambuddy injected, even when the bank
- # came up empty above: that machine may have just ejected its plate, and
- # driving Z into whatever a swap mechanism is doing is not a risk worth
- # taking for a photo of a bed we already know may be bare.
- if (
- frame_bytes is None
- and trigger == "finish_state"
- and restore_plate_enabled
- and not print_dispatch_context.end_gcode_injected(printer_id)
- ):
- wants_restore = await _max_z_for_current_print(printer_id, data, logger)
- if wants_restore is None:
- logger.info(
- "[PLATE-RESTORE] printer %s: print height unknown — capturing without restore",
- printer_id,
- )
- elif await _plate_restore_is_blocked_by_queue(printer_id):
- logger.info(
- "[PLATE-RESTORE] printer %s has queued work — skipping plate restore",
- printer_id,
- )
- elif await _restore_plate_for_finish_photo(printer_id, wants_restore, logger):
- restore_max_z = wants_restore
- if frame_bytes is None and printer.external_camera_enabled and printer.external_camera_url:
- from backend.app.api.routes.camera import live_frame_for_capture
- from backend.app.services.external_camera import capture_frame
- # #2707: this used to collide with the live view and fail, which is
- # how finish-photo notifications went out with no image attached.
- # Leaving frame_bytes None keeps the rest of the fallback chain.
- defer, buffered = live_frame_for_capture(printer_id)
- if defer:
- frame_bytes = buffered
- else:
- frame_bytes = await capture_frame(
- printer.external_camera_url,
- printer.external_camera_type or "mjpeg",
- snapshot_url=printer.external_camera_snapshot_url,
- )
- if frame_bytes:
- logger.info(
- "[FINISH-PHOTO-MOMENT] captured external-camera frame (%d bytes)",
- len(frame_bytes),
- )
- elif frame_bytes is None:
- from backend.app.api.routes.camera import get_buffered_frame
- buffered = get_buffered_frame(printer_id)
- if buffered:
- frame_bytes = buffered
- logger.info(
- "[FINISH-PHOTO-MOMENT] used buffered RTSP frame (%d bytes)",
- len(frame_bytes),
- )
- else:
- from backend.app.services.camera import capture_camera_frame_bytes
- frame_bytes = await capture_camera_frame_bytes(
- ip_address=printer.ip_address,
- access_code=printer.access_code,
- model=printer.model,
- timeout=15,
- )
- if frame_bytes:
- logger.info(
- "[FINISH-PHOTO-MOMENT] captured RTSP frame (%d bytes)",
- len(frame_bytes),
- )
- if frame_bytes:
- if not frame_already_rotated:
- frame_bytes = _apply_camera_rotation(frame_bytes, printer, logger)
- _stage22_finish_frames[printer_id] = frame_bytes
- else:
- logger.warning(
- "[FINISH-PHOTO-MOMENT] no frame captured for printer %s — post-completion fallback will retry",
- printer_id,
- )
- except Exception as e:
- logger.warning(
- "[FINISH-PHOTO-MOMENT] pre-capture failed for printer %s: %s",
- printer_id,
- e,
- )
- finally:
- # #2547: we raised the plate, so we own lowering it — including when the
- # capture above failed or threw partway through.
- if restore_max_z is not None:
- try:
- _park_plate_after_finish_photo(printer_id, restore_max_z, logger)
- except Exception as e:
- logger.warning("[PLATE-RESTORE] printer %s: could not lower plate: %s", printer_id, e)
- # #1790: always unblock the consumer's bounded wait — whether we stored
- # a frame, gave up, or hit an exception. Local ref means cleanup of the
- # dict entry by the consumer doesn't affect signalling.
- producer_done.set()
- def _subtask_name_from_filename(filename: str) -> str:
- """Recover the subtask name a print command would have carried for *filename*.
- The dispatcher derives the printer-facing subtask name from the archive's
- file name, so stripping the extensions back off gives the value MQTT echoes
- on completion. Only the two extensions Bambuddy actually stores are removed,
- and in the order they nest (``.gcode.3mf``), so a model whose own name
- contains a dot -- ``My.Model.3mf`` -- keeps it.
- """
- name = PurePosixPath(filename).name
- for suffix in (".3mf", ".gcode"):
- if name.lower().endswith(suffix):
- name = name[: -len(suffix)]
- return name
- # How the printer marks a subtask name it had to cut short. Observed on real
- # hardware at ~100 characters, but the cut-off is not a fixed character count
- # (a name with multibyte characters came back at 98), so match the marker
- # rather than a length.
- _SUBTASK_TRUNCATION_MARKER = "..."
- def _normalise_subtask_name(name: str) -> str:
- """Canonical form for comparing a dispatched name against MQTT's echo.
- The printer does not echo the name back verbatim: it substitutes
- underscores for spaces. ``H2D_Carbon_Filter_(V2)_Body & Solid Lid`` is
- dispatched and ``H2D_Carbon_Filter_(V2)_Body_&_Solid_Lid`` comes back.
- The 3MF lookup in this module has always known that -- it builds
- space-to-underscore variants of every candidate filename, and its
- directory search normalises both sides before comparing. This exists so
- the completion check reads the same rule from the same place instead of
- growing its own, which is exactly how it came to disagree (#2829).
- """
- return name.strip().replace(" ", "_").casefold()
- def _subtask_names_match(expected: str, observed: str) -> bool:
- """Whether two subtask names describe the same print.
- Beyond the space/underscore substitution, the printer truncates long names
- and marks the cut with ``...``. A truncated echo has to count as a match or
- every print with a long name strands its queue item the same way.
- """
- expected_n = _normalise_subtask_name(expected)
- observed_n = _normalise_subtask_name(observed)
- if expected_n == observed_n:
- return True
- # Either side can be the truncated one: the printer truncates what it
- # echoes, and an archive whose own filename was recorded from a previous
- # truncated echo carries the marker too.
- for full, cut in ((expected_n, observed_n), (observed_n, expected_n)):
- if cut.endswith(_SUBTASK_TRUNCATION_MARKER) and full.startswith(cut[: -len(_SUBTASK_TRUNCATION_MARKER)]):
- return True
- return False
- async def _completion_belongs_to_queue_item(db, item, data: dict) -> bool:
- """Whether this completion event is plausibly about *item*'s print.
- The caller finds its queue row by printer and ``status='printing'`` alone,
- which is all a completion event gives it -- there is no run identifier in
- the MQTT payload to match on. That makes the lookup indiscriminate: any
- completion delivered for this printer closes whichever row happens to be
- printing, however unrelated. Comparing the subtask name against the archive
- the row was dispatched with costs one primary-key load and rules that out.
- Deliberately permissive: it answers False only on a positive disagreement
- between two names we actually have. A row with no archive, an archive with
- no file name, or an event with no subtask name is unverifiable rather than
- wrong, and refusing those would strand the item in ``printing`` and wedge
- the printer's queue -- a worse failure than the one being prevented.
- """
- observed = (data.get("subtask_name") or "").strip()
- if not observed or item.archive_id is None:
- return True
- from backend.app.models.archive import PrintArchive
- archive = await db.get(PrintArchive, item.archive_id)
- if archive is None or not archive.filename:
- return True
- expected = _subtask_name_from_filename(archive.filename)
- if not expected or _subtask_names_match(expected, observed):
- return True
- logging.getLogger(__name__).warning(
- "Ignoring print completion for queue item %s: it was dispatched as %r "
- "(archive %s, %s) but the completion reports subtask %r. Leaving the item "
- "printing rather than closing a run this event is not about.",
- item.id,
- expected,
- archive.id,
- archive.filename,
- observed,
- )
- return False
- async def _recover_fallback_from_cache_before_eviction(printer_id: int, data: dict) -> None:
- """Spend the 3MF download cache on a still-empty fallback archive.
- ``on_print_complete`` drops the cache as its first act, which deletes the
- file. If the cover endpoint (or anything else) pulled the 3MF while the
- print ran and the archive never got one, this is the last moment those bytes
- exist (#2957).
- """
- logger = logging.getLogger(__name__)
- names = [
- n
- for n in (data.get("filename"), data.get("subtask_name"), (data.get("raw_data") or {}).get("subtask_name"))
- if n
- ]
- for name in names:
- try:
- cached = get_cached_3mf(printer_id, name)
- if cached and await try_recover_fallback_archive(printer_id, name, cached):
- return
- except Exception as e:
- logger.debug("[RECOVER] Pre-eviction recovery for %s failed: %s", name, e)
- async def on_print_complete(printer_id: int, data: dict):
- """Handle print completion - update the archive status."""
- import time
- logger = logging.getLogger(__name__)
- start_time = time.time()
- def log_timing(section: str):
- elapsed = time.time() - start_time
- logger.info("[TIMING] %s: %.3fs elapsed", section, elapsed)
- logger.info("[CALLBACK] on_print_complete started for printer %s", printer_id)
- # A kill-switch stop sends its provider notification immediately. Keep the
- # task so the later notification path can await it and avoid a duplicate;
- # if that immediate attempt failed, the regular completion path retries.
- kill_switch_notification_task = _kill_switch_notification_tasks.pop(printer_id, None)
- # Last chance before the bytes go: if this print's archive is still an empty
- # fallback and something downloaded the 3MF while it ran, fill the archive in
- # now. The cover endpoint's copy lives in exactly this cache, and clearing it
- # below deletes the file (#2957).
- await _recover_fallback_from_cache_before_eviction(printer_id, data)
- # A pending cool-off retry has nothing left to recover for — the cache is
- # about to be dropped and the print is over.
- retry_task = _fallback_3mf_retry_tasks.pop(printer_id, None)
- if retry_task and not retry_task.done():
- retry_task.cancel()
- # Drop the 3MF download cache for this printer (#972). The print is over,
- # nothing else legitimately needs the bytes; keeping them would only risk
- # handing a stale file to the next print if it reuses the same name.
- clear_3mf_cache(printer_id)
- try:
- ws_data = {
- "status": data.get("status"),
- "filename": data.get("filename"),
- "subtask_name": data.get("subtask_name"),
- "timelapse_was_active": data.get("timelapse_was_active"),
- }
- await ws_manager.send_print_complete(printer_id, ws_data)
- log_timing("WebSocket send_print_complete")
- except Exception as e:
- logger.warning("[CALLBACK] WebSocket send_print_complete failed: %s", e)
- # Capture user info before clearing (needed for print log entry)
- _print_user_info = printer_manager.get_current_print_user(printer_id)
- # Clear current print user tracking (Issue #206)
- printer_manager.clear_current_print_user(printer_id)
- # If the user explicitly stopped this print from the queue UI the printer will
- # report "failed" or "aborted" via MQTT. Override that to "cancelled" so the
- # correct "print stopped" notification/email is sent instead of a failure alert.
- _raw_status = data.get("status", "completed")
- if printer_id in _user_stopped_printers and _raw_status in ("failed", "aborted"):
- logger.info(
- "[CALLBACK] Overriding status '%s' -> 'cancelled' for printer %s (print was stopped from queue by user)",
- _raw_status,
- printer_id,
- )
- data = {**data, "status": "cancelled"}
- _user_stopped_printers.discard(printer_id)
- # Raise the plate-clear gate for queued dispatch (#961). Any terminal status
- # may have left material on the bed: a user can cancel ten hours into a
- # twelve-hour print, a printer can self-abort mid-job after a clog, and a
- # touchscreen-stop reports `aborted` rather than `cancelled` because
- # `_user_stopped_printers` is only populated when the user stops via the
- # Bambuddy queue UI. Earlier code raised the flag only for completed/failed,
- # which auto-dispatched the next queued print onto a fouled bed two seconds
- # after a touchscreen-abort (#1171). Persisted to DB so the gate survives
- # Auto Off power cycles and Bambuddy restarts.
- _final_status = data.get("status", "completed")
- if _final_status in ("completed", "failed", "aborted", "cancelled"):
- printer_manager.set_awaiting_plate_clear(printer_id, True)
- # MQTT relay - publish print complete
- try:
- printer_info = printer_manager.get_printer(printer_id)
- if printer_info:
- await mqtt_relay.on_print_complete(
- printer_id,
- printer_info.name,
- printer_info.serial_number,
- data.get("filename", ""),
- data.get("subtask_name", ""),
- data.get("status", "completed"),
- )
- except Exception:
- pass # Don't fail print complete callback if MQTT fails
- filename = data.get("filename", "")
- subtask_name = data.get("subtask_name", "")
- if not filename and not subtask_name:
- logger.warning("Print complete without filename or subtask_name")
- return
- logger.info("Print complete - filename: %s, subtask: %s, status: %s", filename, subtask_name, data.get("status"))
- # Build list of possible keys to try (matching how they were registered in on_print_start)
- possible_keys = []
- # Try subtask_name variations first (most reliable for matching)
- if subtask_name:
- possible_keys.append((printer_id, f"{subtask_name}.3mf"))
- possible_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
- possible_keys.append((printer_id, subtask_name))
- # Try filename variations
- if filename:
- # Extract just the filename if it's a path
- fname = filename.split("/")[-1] if "/" in filename else filename
- if fname.endswith(".3mf"):
- possible_keys.append((printer_id, fname))
- elif fname.endswith(".gcode"):
- base_name = fname.rsplit(".", 1)[0]
- possible_keys.append((printer_id, f"{base_name}.gcode.3mf"))
- possible_keys.append((printer_id, f"{base_name}.3mf"))
- possible_keys.append((printer_id, fname))
- else:
- possible_keys.append((printer_id, f"{fname}.gcode.3mf"))
- possible_keys.append((printer_id, f"{fname}.3mf"))
- possible_keys.append((printer_id, fname))
- # Also try full path versions
- if filename.endswith(".3mf"):
- possible_keys.append((printer_id, filename))
- elif filename.endswith(".gcode"):
- base_name = filename.rsplit(".", 1)[0]
- possible_keys.append((printer_id, f"{base_name}.3mf"))
- possible_keys.append((printer_id, filename))
- else:
- possible_keys.append((printer_id, f"{filename}.3mf"))
- possible_keys.append((printer_id, filename))
- # Find the archive for this print
- logger.info("Looking for archive in _active_prints, keys to try: %s...", possible_keys[:5])
- logger.info("Current _active_prints: %s", list(_active_prints.keys()))
- archive_id = None
- for key in possible_keys:
- archive_id = _active_prints.pop(key, None)
- if archive_id:
- logger.info("Found archive %s with key %s", archive_id, key)
- # Also clean up any other keys pointing to this archive
- keys_to_remove = [k for k, v in _active_prints.items() if v == archive_id]
- for k in keys_to_remove:
- _active_prints.pop(k, None)
- break
- if not archive_id:
- # Try to find by filename or subtask_name if not tracked (for prints started before app)
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- # Try matching by subtask_name (stored as print_name) first
- if subtask_name:
- result = await db.execute(
- select(PrintArchive)
- .where(PrintArchive.printer_id == printer_id)
- .where(PrintArchive.status == "printing")
- .where(
- or_(
- PrintArchive.print_name.ilike(f"%{subtask_name}%"),
- PrintArchive.filename.ilike(f"%{subtask_name}%"),
- )
- )
- .order_by(PrintArchive.created_at.desc())
- .limit(1)
- )
- archive = result.scalar_one_or_none()
- if archive:
- archive_id = archive.id
- logger.info("Found archive %s by subtask_name match: %s", archive_id, subtask_name)
- # Also try by filename
- if not archive_id and filename:
- result = await db.execute(
- select(PrintArchive)
- .where(PrintArchive.printer_id == printer_id)
- .where(PrintArchive.filename == filename)
- .where(PrintArchive.status == "printing")
- .order_by(PrintArchive.created_at.desc())
- .limit(1)
- )
- archive = result.scalar_one_or_none()
- if archive:
- archive_id = archive.id
- # Cleanup: delete uploaded file from printer SD card to prevent phantom prints (Issue #374, #1542)
- # The print scheduler uploads files to the SD card root (/). Some printers (e.g. P1S, A1)
- # auto-start files found in root on power cycle, causing ghost prints.
- # Must run before the archive_id early-return so it executes even when archiving is disabled.
- try:
- if subtask_name:
- archive_filename: str | None = None
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if archive_id:
- archive_row = await db.execute(select(PrintArchive.filename).where(PrintArchive.id == archive_id))
- archive_filename = archive_row.scalar_one_or_none()
- if printer:
- from backend.app.services.bambu_ftp import DeleteResult, delete_file_async
- from backend.app.utils.filename import derive_remote_filename
- # Primary candidate: the exact path the dispatcher uploaded to
- # (derived from archive.filename via the same rule as upload).
- # Without it, a library row that ended up with a doubled
- # .gcode.3mf (#1542) leaves the real file behind because the
- # subtask_name + ext fallbacks below don't match what's on the
- # SD card. Fallbacks remain for archive-less prints (subtask
- # never resolved to an archive) and for older naming variants.
- candidate_paths: list[str] = []
- if archive_filename:
- candidate_paths.append(f"/{derive_remote_filename(archive_filename)}")
- for ext in (".3mf", ".gcode"):
- fallback = f"/{subtask_name}{ext}"
- if fallback not in candidate_paths:
- candidate_paths.append(fallback)
- # Three outcomes track across all candidates so the final log
- # line reflects what actually happened. The A1 in #1721 always
- # ends here with ``any_not_found=True`` and the others False
- # — its firmware auto-cleans the SD card before our cleanup
- # runs, every candidate FTP-DELE returns 550, and the old
- # code burned 3 retries × 2 s × 3 candidates per print
- # logging a misleading "may linger" WARNING on a successful
- # print.
- any_deleted = False
- any_real_failure = False
- any_not_found = False
- for remote_path in candidate_paths:
- # Retry only the FAILED case — 550 NOT_FOUND will never
- # recover by waiting, so a "file isn't here" answer
- # advances immediately to the next candidate without
- # consuming the retry budget.
- for attempt in range(1, 4):
- try:
- delete_result = await delete_file_async(
- printer.ip_address,
- printer.access_code,
- remote_path,
- printer_model=printer.model,
- )
- except Exception as e:
- delete_result = DeleteResult.FAILED
- logger.warning(
- "SD card cleanup attempt %d/3 raised for %s: %s",
- attempt,
- remote_path,
- e,
- )
- if delete_result == DeleteResult.DELETED:
- any_deleted = True
- logger.info("Deleted %s from printer %s SD card", remote_path, printer.name)
- break
- if delete_result == DeleteResult.NOT_FOUND:
- any_not_found = True
- break # 550 will not recover; try next candidate
- # FAILED: real error — retry with backoff, then give up
- if attempt < 3:
- await asyncio.sleep(2)
- else:
- any_real_failure = True
- logger.warning(
- "SD card cleanup failed after 3 attempts for %s "
- "(network/auth/transient error — file may linger on SD card)",
- remote_path,
- )
- if not any_deleted and not any_real_failure and any_not_found:
- # Every candidate said "not here." Either the printer
- # firmware swept the SD card itself (common on A1) or the
- # dispatcher's upload path doesn't match our candidate
- # rule. Either way: nothing to clean up, no warning.
- logger.debug(
- "SD card cleanup: nothing to delete on %s — every candidate returned 550 "
- "(printer likely self-cleaned)",
- printer.name,
- )
- except Exception as e:
- logger.warning("SD card file cleanup failed for printer %s: %s", printer_id, e)
- log_timing("SD card cleanup")
- # Update queue item status early — must run before the archive_id early-return
- # so queue items don't get stuck in "printing" when archive lookup fails.
- # Uses run_with_retry to handle SQLite "database is locked" errors (#897).
- queue_item_id = None
- billing_run_id: str | None = None
- billing_user_id: int | None = None
- billing_cost_center_id: int | None = None
- billing_plate_id: int | None = None
- queue_status = None
- queue_auto_off = False
- try:
- from backend.app.core.database import run_with_retry
- from backend.app.models.print_queue import PrintQueueItem
- async def _update_queue_status(db):
- nonlocal billing_run_id, billing_user_id, billing_cost_center_id, billing_plate_id
- nonlocal queue_item_id, queue_status, queue_auto_off
- result = await db.execute(
- select(PrintQueueItem)
- .where(PrintQueueItem.printer_id == printer_id)
- .where(PrintQueueItem.status == "printing")
- )
- printing_items = list(result.scalars().all())
- if len(printing_items) > 1:
- logger.warning(
- "BUG: Multiple queue items in 'printing' status for printer %s: %s",
- printer_id,
- [(i.id, i.archive_id, i.library_file_id) for i in printing_items],
- )
- item = printing_items[0] if printing_items else None
- if item is not None and not await _completion_belongs_to_queue_item(db, item, data):
- return
- if item:
- queue_status = data.get("status", "completed")
- # MQTT sends "aborted" for cancelled prints; normalise to
- # "cancelled" so it matches the queue schema Literal.
- if queue_status == "aborted":
- queue_status = "cancelled"
- item.status = queue_status
- item.completed_at = datetime.now(timezone.utc)
- if queue_status == "failed" and not item.error_message:
- item.error_message = _format_hms_error_summary(data.get("hms_errors") or [])
- # Bump usage counters on the source library file so admins can
- # sort by "last printed" and (eventually) auto-purge stale
- # files — #1008.
- await _bump_library_file_usage_if_completed(db, item, queue_status)
- await db.commit()
- queue_item_id = item.id
- billing_run_id = item.billing_run_id
- billing_user_id = item.created_by_id
- billing_cost_center_id = item.cost_center_id
- billing_plate_id = item.plate_id
- queue_auto_off = item.auto_off_after
- logger.info("Updated queue item %s status to %s", item.id, queue_status)
- await run_with_retry(_update_queue_status, label="queue status update")
- # Post-commit side effects (notifications, MQTT relay, auto-off) use
- # their own sessions and have their own error handling — no retry needed.
- if queue_item_id is not None:
- # Batch orders (#342): this run may have been the last one an order
- # owed. Re-evaluate here rather than lazily on read, so a finished
- # order reports itself complete without someone opening the page.
- try:
- from backend.app.services.print_batch import refresh_batch_status_for_item
- async with async_session() as db:
- await refresh_batch_status_for_item(db, queue_item_id)
- await db.commit()
- except Exception as e:
- logger.warning("[BATCH] Failed to refresh batch status for queue item %s: %s", queue_item_id, e)
- # MQTT relay - publish queue job completed
- try:
- printer_info = printer_manager.get_printer(printer_id)
- await mqtt_relay.on_queue_job_completed(
- job_id=queue_item_id,
- filename=filename or subtask_name,
- printer_id=printer_id,
- printer_name=printer_info.name if printer_info else "Unknown",
- status=queue_status,
- )
- except Exception:
- pass # Don't fail if MQTT fails
- # Check if queue is now empty and send notification
- try:
- from sqlalchemy import func as sa_func
- async with async_session() as db:
- count_result = await db.execute(
- select(sa_func.count(PrintQueueItem.id)).where(PrintQueueItem.status == "pending")
- )
- pending_count = count_result.scalar() or 0
- if pending_count == 0:
- today_start = datetime.now(timezone.utc).replace(hour=0, minute=0, second=0, microsecond=0)
- completed_result = await db.execute(
- select(sa_func.count(PrintQueueItem.id)).where(
- PrintQueueItem.status.in_(["completed", "failed", "skipped"]),
- PrintQueueItem.completed_at >= today_start,
- )
- )
- completed_count = completed_result.scalar() or 1
- await notification_service.on_queue_completed(
- completed_count=completed_count,
- db=db,
- )
- except Exception:
- pass # Don't fail if notification fails
- # Handle auto_off_after - power off printer if the queue item opted
- # in. Delegates to the smart-plug manager so the off honours each
- # plug's configured strategy (time delay or temperature threshold),
- # is cancelled if the printer starts printing again, and never cuts
- # power on a loaded print (#1890). Previously an inline block here
- # hardcoded a 50°C / 600s cooldown wait and powered off on the
- # timeout regardless of print state — cutting a touchscreen reprint.
- if queue_auto_off:
- try:
- async with async_session() as db:
- await smart_plug_manager.schedule_off_after_queue_job(printer_id, db)
- except Exception as e:
- logger.warning("Failed to schedule queue auto-off for printer %s: %s", printer_id, e)
- except Exception as e:
- logging.getLogger(__name__).warning(f"Queue item update failed: {e}")
- log_timing("Queue item update")
- # Register bed cooldown waiter (event-driven via on_bed_temp_update callback).
- # Must run before archive_id early-return so it fires for all prints (including
- # prints started from BambuStudio/touchscreen that have no archive).
- if data.get("status") == "completed":
- try:
- from backend.app.api.routes.settings import get_setting
- async with async_session() as db:
- threshold_str = await get_setting(db, "bed_cooled_threshold")
- threshold = float(threshold_str) if threshold_str else 35.0
- # Check if any provider has on_bed_cooled enabled (skip registration if none)
- async with async_session() as db:
- providers = await notification_service._get_providers_for_event(db, "on_bed_cooled", printer_id)
- if providers:
- _bed_cool_waiters[printer_id] = {
- "threshold": threshold,
- "filename": filename or subtask_name or "",
- "registered_at": time.time(),
- }
- logger.info(
- "[BED-COOL] Registered waiter for printer %s (threshold: %.0f°C)",
- printer_id,
- threshold,
- )
- else:
- logger.debug("[BED-COOL] No providers enabled for bed_cooled on printer %s", printer_id)
- except Exception as e:
- logger.warning("[BED-COOL] Failed to register waiter: %s", e)
- # Capture the slicer estimate before usage tracking runs. The tracker may
- # update archive.cost with this run's measured cost; billing partial runs
- # against that already-partial value would discount the charge twice.
- billing_planned_grams: float | None = None
- billing_base_cost: float | None = None
- if archive_id:
- try:
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- billing_archive = await db.get(PrintArchive, archive_id)
- if billing_archive:
- billing_path = (
- app_settings.base_dir / billing_archive.file_path if billing_archive.file_path else None
- ) # SEC-PATH-OK: archive.file_path is DB-stored, internally generated
- billing_planned_grams, billing_base_cost = _plate_scoped_run_estimate(
- billing_archive,
- billing_path,
- billing_plate_id if billing_plate_id is not None else _get_start_plate_id(archive_id),
- )
- except Exception as e:
- logger.warning("[FINANCE] Failed to capture planned usage for archive %s: %s", archive_id, e)
- # --- Track filament consumption (must run before archive_id early-return so usage
- # is recorded even when auto-archive is disabled) ---
- usage_results: list[dict] = []
- # Prefer ams_mapping captured from MQTT request topic (works for all print sources)
- stored_ams_mapping = data.get("ams_mapping")
- # Fallback to _print_ams_mappings for queue/reprint (set before print starts)
- if not stored_ams_mapping and archive_id:
- stored_ams_mapping = _print_ams_mappings.pop(archive_id, None)
- # Always drain the plate_id register on completion — the session already
- # consumed it at print-start injection; leaving it would leak into the next
- # print on the same archive_id (rare but possible with reprints) (#1697).
- # Capture the popped value so the completion notification can scope the
- # archive-level (summed-across-plates per #1593) filament + time totals
- # down to the single plate that was actually printed (#1785).
- notify_plate_id: int | None = None
- if archive_id:
- notify_plate_id = _print_plate_ids.pop(archive_id, None)
- # Internal inventory: track AMS remain% deltas (skip if Spoolman handles usage)
- try:
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- _spoolman_on = await get_setting(db, "spoolman_enabled")
- if not _spoolman_on or _spoolman_on.lower() != "true":
- from backend.app.services.usage_tracker import on_print_complete as usage_on_print_complete
- async with async_session() as db:
- usage_results = await usage_on_print_complete(
- printer_id,
- data,
- printer_manager,
- db,
- archive_id=archive_id,
- ams_mapping=stored_ams_mapping,
- )
- if usage_results:
- await ws_manager.broadcast(
- {
- "type": "spool_usage_logged",
- "printer_id": printer_id,
- "usage": usage_results,
- }
- )
- log_timing("Usage tracker")
- except Exception as e:
- logger.warning("Usage tracker on_print_complete failed: %s", e)
- # Drop the print-start context unconditionally — the Spoolman branch above
- # skips the internal tracker entirely, so nothing else would clear what
- # print start captured, and a row surviving its print would be restored
- # onto the next one after a restart.
- try:
- from backend.app.services.usage_tracker import discard_session
- async with async_session() as db:
- await discard_session(db, printer_id)
- except Exception as e:
- logger.warning("Failed to clear persisted print session for printer %s: %s", printer_id, e)
- # Spoolman: report filament usage (requires archive_id for tracking data lookup)
- if archive_id:
- if data.get("status") == "completed":
- try:
- await _report_spoolman_usage(printer_id, archive_id)
- log_timing("Spoolman usage report")
- except Exception as e:
- logger.warning("Spoolman usage reporting failed: %s", e)
- else:
- # Report partial usage if tracking data exists (only stored when weight sync is disabled)
- try:
- async with async_session() as db:
- await _cleanup_spoolman_tracking(
- printer_id,
- archive_id,
- db,
- last_layer_num=data.get("last_layer_num"),
- last_progress=data.get("last_progress"),
- )
- except Exception as e:
- logger.debug("[SPOOLMAN] Cleanup failed: %s", e)
- log_timing("Filament usage tracking")
- if not archive_id:
- # The printer's own calibration run has no archive by design, so this
- # arrives here every time one finishes. Returning before the no-archive
- # notification is not just noise control: that path attributes an
- # unmatched completion to any queue item this printer finished in the
- # last five minutes, which for a calibration that runs alongside a real
- # print means emailing its owner that their print is done, twice and
- # early. Everything above this point has already run — the plate-clear
- # gate, the queue reconciliation, the SD-card cleanup — so only the
- # notification is skipped.
- if is_internal_printer_job(filename, subtask_name):
- logger.info(
- "[CALLBACK] Internal printer job completed, no notification: filename=%s, subtask=%s",
- filename,
- subtask_name,
- )
- return
- logger.warning("Could not find archive for print complete: filename=%s, subtask=%s", filename, subtask_name)
- # Still send print-complete/failed/stopped notifications even without an archive.
- # Try to enrich with queue/library-file data so user-specific emails work too.
- async def _notify_no_archive():
- try:
- async with async_session() as db:
- from backend.app.models.library import LibraryFile
- from backend.app.models.print_queue import PrintQueueItem
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer_obj = result.scalar_one_or_none()
- p_name = printer_obj.name if printer_obj else f"Printer {printer_id}"
- # Try to find the most-recent queue item for this printer so we can
- # recover created_by_id and estimated print time.
- # NOTE: By the time this task runs the queue item status has already
- # been updated to a terminal state (completed/failed/cancelled), so
- # we look for recently-completed items (within the last 5 minutes).
- no_archive_data: dict | None = None
- try:
- cutoff = datetime.now(timezone.utc) - timedelta(minutes=5)
- q_result = await db.execute(
- select(PrintQueueItem)
- .where(PrintQueueItem.printer_id == printer_id)
- .where(PrintQueueItem.status.in_(["completed", "failed", "cancelled"]))
- .where(PrintQueueItem.completed_at >= cutoff)
- .order_by(PrintQueueItem.completed_at.desc())
- .limit(1)
- )
- queue_item = q_result.scalar_one_or_none()
- if queue_item:
- no_archive_data = {"created_by_id": queue_item.created_by_id}
- # Pull estimated time from library file when available
- if queue_item.library_file_id:
- lib_result = await db.execute(
- select(LibraryFile).where(LibraryFile.id == queue_item.library_file_id)
- )
- lib_file = lib_result.scalar_one_or_none()
- if lib_file and lib_file.print_time_seconds:
- no_archive_data["print_time_seconds"] = lib_file.print_time_seconds
- except Exception as lookup_err:
- logger.debug(
- "[NOTIFY-BG] Could not look up queue item for no-archive notification: %s", lookup_err
- )
- # Enrich with usage tracker results (captured in enclosing scope)
- if usage_results:
- if no_archive_data is None:
- no_archive_data = {}
- total_from_usage = sum(r.get("weight_used", 0) for r in usage_results)
- if total_from_usage > 0:
- no_archive_data["actual_filament_grams"] = round(total_from_usage, 1)
- no_archive_data["usage_results"] = usage_results
- # Try MQTT remaining_time for print duration when no queue/library data
- if no_archive_data and not no_archive_data.get("print_time_seconds"):
- mqtt_remaining = data.get("remaining_time")
- if mqtt_remaining and isinstance(mqtt_remaining, (int, float)) and mqtt_remaining > 0:
- no_archive_data["print_time_seconds"] = int(mqtt_remaining)
- ps = data.get("status", "completed")
- logger.info(
- "[NOTIFY-BG] Sending notification without archive: printer=%s, status=%s", printer_id, ps
- )
- if not await _kill_switch_notification_already_sent(kill_switch_notification_task):
- await notification_service.on_print_complete(
- printer_id, p_name, ps, data, db, archive_data=no_archive_data
- )
- else:
- logger.info("[NOTIFY-BG] Skipped duplicate kill-switch provider notification")
- # Send user-specific email if we have a created_by_id
- if no_archive_data and no_archive_data.get("created_by_id"):
- raw_filename = data.get("subtask_name") or data.get("filename", "Unknown")
- await _dispatch_user_print_email(
- ps,
- no_archive_data["created_by_id"],
- p_name,
- raw_filename,
- db,
- )
- logger.info("[NOTIFY-BG] Completed (no-archive path)")
- except Exception as e:
- logger.warning("[NOTIFY-BG] Failed to send notification without archive: %s", e, exc_info=True)
- spawn_background_task(_notify_no_archive(), name="notify-no-archive")
- return
- log_timing("Archive lookup")
- # Update archive status
- logger.info("[ARCHIVE] Updating archive %s status...", archive_id)
- try:
- async with async_session() as db:
- service = ArchiveService(db)
- status = data.get("status", "completed")
- hms_errors = data.get("hms_errors", []) if status == "failed" else None
- if hms_errors:
- logger.info("[ARCHIVE] HMS errors at failure: %s", hms_errors)
- failure_reason = derive_failure_reason(status, hms_errors)
- if data.get("_reconciled"):
- # A reconciled completion closes out a stale archive at
- # reconnect — it is not a user action, so don't mislabel it
- # "userCancelled". It shares the stale-cleanup path's key
- # (issue #2974) and records that the real end time is unknown,
- # which is also why its logged duration is 0 (#2592).
- failure_reason = "noStatusUpdate"
- if failure_reason:
- logger.info("[ARCHIVE] failure_reason=%r (status=%s)", failure_reason, status)
- elif status == "failed" and hms_errors:
- logger.info("[ARCHIVE] HMS errors present but none matched a known failure-reason short code")
- await service.update_archive_status(
- archive_id,
- status=status,
- completed_at=(
- datetime.now(timezone.utc) if status in ("completed", "failed", "aborted", "cancelled") else None
- ),
- failure_reason=failure_reason,
- )
- logger.info(
- "[ARCHIVE] Archive %s status updated to %s, failure_reason=%s", archive_id, status, failure_reason
- )
- await ws_manager.send_archive_updated(
- {
- "id": archive_id,
- "status": status,
- }
- )
- logger.info("[ARCHIVE] WebSocket notification sent for archive %s", archive_id)
- # MQTT relay - publish archive updated
- try:
- await mqtt_relay.on_archive_updated(
- archive_id=archive_id,
- print_name=filename or subtask_name,
- status=status,
- )
- except Exception:
- pass # Don't fail if MQTT fails
- except Exception as e:
- logger.error("[ARCHIVE] Failed to update archive %s status: %s", archive_id, e, exc_info=True)
- # Continue with other operations even if archive update fails
- log_timing("Archive status update")
- # Apply finance wallet charge or release reservations once. For all partial
- # terminal states (failed, aborted at the printer display, or cancelled via
- # Bambuddy) use this run's measured spool delta, falling back to the last
- # valid printer progress. PrintArchive.filament_used_grams is the slicer
- # estimate and therefore cannot represent an interrupted run.
- try:
- if data.get("status") in ("completed", "failed", "aborted", "cancelled"):
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- from backend.app.services.finance_billing import apply_print_charge_for_archive
- archive = await db.get(PrintArchive, archive_id)
- if archive and billing_run_id is None:
- billing_run_id = getattr(archive, "billing_run_id", None)
- if archive and archive.created_by_id is None and _print_user_info:
- archive.created_by_id = _print_user_info.get("user_id")
- await db.flush()
- run_status = data.get("status", "completed")
- last_progress = data.get("last_progress")
- if last_progress is None:
- last_progress = data.get("progress")
- actual_run_grams = _compute_run_filament_grams(
- run_status,
- billing_planned_grams,
- last_progress,
- usage_results,
- )
- filament_usage = (actual_run_grams, billing_planned_grams) if run_status != "completed" else None
- in_memory_cost_center_id = _print_cost_center_ids.pop(archive_id, None)
- charged = await apply_print_charge_for_archive(
- db,
- archive_id,
- charged_user_id=billing_user_id,
- cost_center_id=(
- billing_cost_center_id if billing_cost_center_id is not None else in_memory_cost_center_id
- ),
- print_queue_id=queue_item_id,
- print_run_id=billing_run_id,
- base_cost_override=billing_base_cost,
- filament_usage=filament_usage,
- )
- await db.commit()
- if charged:
- logger.info("[FINANCE] Applied print charge for archive %s", archive_id)
- except Exception as e:
- logger.warning("[FINANCE] Failed to apply print charge for archive %s: %s", archive_id, e)
- printer_info = printer_manager.get_printer(printer_id)
- billing_printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
- billing_filename = filename or subtask_name or "Unknown"
- billing_error = str(e)
- try:
- await ws_manager.broadcast(
- {
- "type": "billing_charge_failed",
- "printer_id": printer_id,
- "printer_name": billing_printer_name,
- "filename": billing_filename,
- "archive_id": archive_id,
- }
- )
- except Exception as notification_error:
- logger.error(
- "[FINANCE] Failed to broadcast billing error for archive %s: %s",
- archive_id,
- notification_error,
- )
- async def _notify_billing_charge_failed() -> None:
- try:
- async with async_session() as notification_db:
- await notification_service.on_billing_charge_failed(
- printer_id,
- billing_printer_name,
- billing_filename,
- archive_id,
- billing_error,
- notification_db,
- )
- except Exception as provider_error:
- logger.error(
- "[FINANCE] Failed to send provider billing alert for archive %s: %s",
- archive_id,
- provider_error,
- exc_info=True,
- )
- spawn_background_task(
- _notify_billing_charge_failed(),
- name=f"billing-charge-failed-{archive_id}",
- )
- log_timing("Finance charge update")
- # Write independent print log entry (separate table, never touches archives)
- try:
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- from backend.app.services.print_log import write_log_entry
- archive = await db.get(PrintArchive, archive_id)
- if archive:
- # Back-fill created_by_id on reprint (#730): reprint reuses the
- # source archive row rather than creating a new one, so an
- # archive that was auto-created from a printer-initiated
- # print (created_by_id=NULL) would otherwise stay unattributed
- # forever. When we have a print-session user AND the archive
- # has no attribution yet, credit the current user. Never
- # overwrite an existing attribution — the original uploader
- # keeps ownership.
- _print_user_id = _print_user_info.get("user_id") if _print_user_info else None
- if archive.created_by_id is None and _print_user_id is not None:
- archive.created_by_id = _print_user_id
- p_info = printer_manager.get_printer(printer_id)
- # Per-run actuals — written to PrintLogEntry so stats reflect
- # what THIS print actually used, not the source archive's
- # first-run values (#1378). Helper handles the partial-print
- # math (failed / cancelled / stopped get scaled to progress
- # or to tracked spool deltas).
- _run_status = data.get("status", "completed")
- # #2614: scope the per-run estimate to the printed plate. For a
- # multi-plate 3MF dispatched one plate at a time, the archive's
- # filament/cost are the whole-file totals; the PrintLogEntry must
- # reflect only this plate. No effect on single-plate archives (the
- # plate estimate equals the whole-file value) or on the tracker
- # path (measured spool deltas win in _compute_run_filament_grams).
- _est_full_path = (
- app_settings.base_dir / archive.file_path if archive.file_path else None
- ) # SEC-PATH-OK: archive.file_path is DB-stored, internally generated
- _est_grams, _est_cost = _plate_scoped_run_estimate(archive, _est_full_path)
- _run_grams = _compute_run_filament_grams(
- _run_status,
- _est_grams,
- data.get("last_progress", data.get("progress")),
- usage_results,
- )
- # Per-run cost — prefer usage_results sum. For partial prints
- # we deliberately skip the topup-to-estimate logic in
- # usage_tracker (which assumes the print completed); the raw
- # tracked-spool sum is closer to what THIS run actually cost.
- _run_cost: float | None = None
- if usage_results:
- _run_cost = sum(r.get("cost") or 0 for r in usage_results) or None
- if _run_cost is None and _run_status == "completed":
- _run_cost = _est_cost
- await write_log_entry(
- db,
- archive_id=archive.id,
- # Captured by _update_queue_status above; None for
- # printer-initiated prints with no queue row. Batch
- # cost/energy roll-up joins on it (#342).
- queue_item_id=queue_item_id,
- status=_run_status,
- print_name=archive.print_name,
- printer_name=p_info.name if p_info else None,
- printer_id=printer_id,
- started_at=archive.started_at,
- completed_at=archive.completed_at,
- filament_type=archive.filament_type,
- filament_color=archive.filament_color,
- filament_used_grams=_run_grams,
- cost=_run_cost,
- failure_reason=archive.failure_reason,
- thumbnail_path=archive.thumbnail_path,
- created_by_id=archive.created_by_id,
- created_by_username=_print_user_info.get("username") if _print_user_info else None,
- # Reconciled completions have an unknown real end time —
- # log 0 duration instead of the whole disconnect gap (#2592).
- reconciled=bool(data.get("_reconciled")),
- )
- await db.commit()
- logger.info("[PRINT_LOG] Log entry written for archive %s", archive_id)
- except Exception as e:
- logger.warning("[PRINT_LOG] Failed to write log entry for archive %s: %s", archive_id, e)
- log_timing("Print log entry")
- # Run slow operations as background tasks to avoid blocking the event loop
- # These operations can take 5-10+ seconds and would freeze the UI if awaited
- async def _background_energy_calculation():
- """Calculate and save energy usage in background.
- Reads the starting kWh from the archive row (#941: persisted so a mid-print
- backend restart no longer loses per-print energy data).
- """
- try:
- logger.info("[ENERGY-BG] Starting energy calculation for archive %s", archive_id)
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- archive = await db.get(PrintArchive, archive_id)
- if archive is None:
- logger.warning("[ENERGY-BG] Archive %s no longer exists", archive_id)
- return
- starting_kwh = archive.energy_start_kwh
- if starting_kwh is None:
- logger.info("[ENERGY-BG] No start kWh recorded for archive %s", archive_id)
- return
- candidates = await energy_plug_candidates(db, printer_id)
- if not candidates:
- logger.info("[ENERGY-BG] No smart plug for printer %s", printer_id)
- return
- # Same ordering as the start reading, so the delta below is
- # against the counter that produced `starting_kwh` (#2859).
- selected = await select_energy_reading(candidates, _get_plug_energy, db)
- if selected is None:
- logger.warning(
- "[ENERGY-BG] No plug on printer %s reports a lifetime energy counter (tried: %s)",
- printer_id,
- ", ".join(plug.name for plug in candidates),
- )
- return
- plug, energy = selected
- logger.info("[ENERGY-BG] Energy response from plug '%s': %s", plug.name, energy)
- energy_used = round(energy["total"] - starting_kwh, 4)
- logger.info("[ENERGY-BG] Per-print energy: %s kWh", energy_used)
- if energy_used < 0:
- logger.warning(
- "[ENERGY-BG] Negative energy delta for archive %s (start=%s, end=%s) — counter reset?",
- archive_id,
- starting_kwh,
- energy["total"],
- )
- return
- from backend.app.api.routes.settings import get_setting
- energy_cost_per_kwh = await get_setting(db, "energy_cost_per_kwh")
- cost_per_kwh = float(energy_cost_per_kwh) if energy_cost_per_kwh else 0.15
- energy_cost_value = round(energy_used * cost_per_kwh, 3)
- # First-run-only overwrite of archive.energy_kwh / energy_cost so a
- # reprint doesn't visually clobber the source archive's energy data
- # (#1378). Reprint energy lives in the matching PrintLogEntry below.
- from sqlalchemy import func
- from backend.app.models.print_log import PrintLogEntry
- existing_runs = await db.scalar(
- select(func.count(PrintLogEntry.id)).where(PrintLogEntry.archive_id == archive_id)
- )
- if (existing_runs or 0) <= 1:
- # 0 = legacy archive that pre-dates per-run logging; 1 = the row
- # we just wrote for THIS print. Either way it's the first run.
- archive.energy_kwh = energy_used
- archive.energy_cost = energy_cost_value
- # Backfill the latest PrintLogEntry for this archive with energy
- # (write_log_entry above ran before this background task completed,
- # so energy fields are still NULL on that row).
- latest_run = await db.execute(
- select(PrintLogEntry)
- .where(PrintLogEntry.archive_id == archive_id)
- .order_by(PrintLogEntry.id.desc())
- .limit(1)
- )
- run_row = latest_run.scalar_one_or_none()
- if run_row is not None:
- run_row.energy_kwh = energy_used
- run_row.energy_cost = energy_cost_value
- await db.commit()
- logger.info("[ENERGY-BG] Saved: %s kWh, cost=%s", energy_used, energy_cost_value)
- except Exception as e:
- logger.warning("[ENERGY-BG] Failed: %s", e)
- async def _background_finish_photo() -> str | None:
- """Capture finish photo in background. Returns photo filename if captured."""
- # #2547: set once this function has raised the plate itself (the
- # timelapse path, where the moment producer returned without doing it).
- # Declared out here so the `finally` can lower it again no matter where
- # the capture below fails.
- plate_restored_z: float | None = None
- try:
- logger.info("[PHOTO-BG] Starting finish photo capture for archive %s", archive_id)
- from backend.app.api.routes.camera import _active_chamber_streams, _active_streams, get_buffered_frame
- # Read phase: settings + printer + archive in a short session, released
- # BEFORE the capture pipeline below. The capture (timelapse last-frame,
- # stage-22 wait, external-camera grab, or a fresh RTSP shot) can take
- # tens of seconds; holding this session across it pinned one pooled
- # connection idle-in-transaction per finishing print (issue #2572).
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- from backend.app.models.archive import PrintArchive
- from backend.app.models.printer import Printer
- capture_enabled = await get_setting(db, "capture_finish_photo")
- if capture_enabled is not None and capture_enabled.lower() != "true":
- return None
- if not archive_id:
- return None
- printer = (await db.execute(select(Printer).where(Printer.id == printer_id))).scalar_one_or_none()
- archive = (
- await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
- ).scalar_one_or_none()
- if not printer or not archive:
- return None
- import uuid
- from datetime import datetime
- from backend.app.utils.archive_paths import archive_dir as resolve_archive_dir
- if not archive.file_path:
- logger.warning("[PHOTO-BG] Archive %s has no file_path, using fallback dir", archive_id)
- archive_dir = resolve_archive_dir(archive)
- photo_filename = None
- # Prefer the timelapse last-frame source when a timelapse was
- # recording — it captures the moment after the toolhead parks
- # but before the bed drops, which the live-camera grab below
- # would miss (#1397). Skipped for external cameras (those have
- # their own framing and don't see a Bambu timelapse). Only
- # runs when the USER explicitly enabled timelapse for this
- # print — #1721 removed Bambuddy's force-on at dispatch
- # because it caused per-layer nozzle parking on Smooth-mode
- # slicer profiles.
- prefer_timelapse_source = bool(data.get("timelapse_was_active")) and not (
- printer.external_camera_enabled and printer.external_camera_url
- )
- timelapse_still_pending = False
- if prefer_timelapse_source:
- photo_filename, timelapse_still_pending = await _capture_finish_photo_from_timelapse(
- archive_id=archive_id,
- archive_dir=archive_dir,
- rotation=getattr(printer, "camera_rotation", 0),
- )
- # #1721: replacement framing path — on_finish_photo_moment
- # pre-captured a frame at the stage-22 / FINISH edge (toolhead
- # parked, bed not yet dropped) and cached the JPEG bytes in
- # _stage22_finish_frames. Consume them now so the saved photo
- # has the better framing instead of the post-bed-drop angle
- # the live-camera fallback below would give.
- if not photo_filename:
- # #1790: on the FINISH-state fallback path the producer
- # task is dispatched back-to-back with this consumer, so
- # a bare pop would race past with an empty result and
- # the RTSP fallback below would collide with the
- # producer's still-in-flight grab (single-client RTSP
- # on Bambu printers). Wait for the producer to finish
- # or give up before touching the cache.
- #
- # #2547: 20s was enough when the producer only ever grabbed a
- # frame. It now also raises the plate first, which costs the
- # settle window before the grab even starts — so the budget has
- # to cover settle + a worst-case 15s RTSP timeout, and still sit
- # under the notification's own photo wait below.
- in_flight = _stage22_finish_in_flight.pop(printer_id, None)
- if in_flight is not None:
- try:
- await asyncio.wait_for(in_flight.wait(), timeout=_FINISH_PHOTO_PRODUCER_WAIT_SECONDS)
- except asyncio.TimeoutError:
- logger.warning(
- "[PHOTO-BG] timed out waiting for stage-22 producer for printer %s — proceeding to fallback",
- printer_id,
- )
- cached_frame = _stage22_finish_frames.pop(printer_id, None)
- if cached_frame:
- # Already rotated by the producer (#2708) — rotating again
- # here would undo the fix on the banked-frame path, whose
- # bytes reach the cache having been rotated once already.
- photos_dir = archive_dir / "photos"
- photos_dir.mkdir(parents=True, exist_ok=True)
- timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
- photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
- photo_path = photos_dir / photo_filename
- await asyncio.to_thread(photo_path.write_bytes, cached_frame)
- logger.info(
- "[PHOTO-BG] Saved stage-22 pre-captured frame: %s (%d bytes)",
- photo_filename,
- len(cached_frame),
- )
- # #2547: the timelapse path reaches the live grab below whenever the
- # video hasn't landed in time — the documented usual outcome on
- # P1-series, where transfers are slowest. `on_finish_photo_moment`
- # returned early for those prints without raising the plate, so
- # without this the photo that actually ships in the notification is
- # of an already-dropped plate: exactly the framing #1145/#1397/#1565
- # asked us to fix. The archive still gets the better video frame
- # later; this is about the image the user is sent.
- #
- # Gated on `timelapse_was_active` precisely because that is the
- # condition under which the producer skipped. On every other path it
- # has already raised and lowered the plate, and repeating that here
- # would be a second pointless round trip.
- if (
- not photo_filename
- and data.get("timelapse_was_active")
- and not print_dispatch_context.end_gcode_injected(printer_id)
- ):
- try:
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- restore_setting = await get_setting(db, "finish_photo_restore_plate")
- if restore_setting is None or restore_setting.lower() == "true":
- max_z = await _max_z_for_current_print(printer_id, data, logger)
- if max_z is not None and not await _plate_restore_is_blocked_by_queue(printer_id):
- if await _restore_plate_for_finish_photo(printer_id, max_z, logger):
- plate_restored_z = max_z
- except Exception as e:
- logger.warning("[PLATE-RESTORE] printer %s: restore failed: %s", printer_id, e)
- # Fallback chain: external camera → buffered live frame →
- # fresh RTSP capture. Only runs if the timelapse path above
- # didn't already produce a photo.
- if not photo_filename:
- if printer.external_camera_enabled and printer.external_camera_url:
- logger.info("[PHOTO-BG] Using external camera")
- from backend.app.api.routes.camera import live_frame_for_capture
- from backend.app.services.external_camera import capture_frame
- # #2707: the second half of the finish-photo failure — the
- # pre-capture and this fallback both collided with the live
- # view. None here continues down the fallback chain.
- defer, buffered = live_frame_for_capture(printer_id)
- if defer:
- frame_data = buffered
- else:
- frame_data = await capture_frame(
- printer.external_camera_url,
- printer.external_camera_type or "mjpeg",
- snapshot_url=printer.external_camera_snapshot_url,
- )
- if frame_data:
- frame_data = _apply_camera_rotation(frame_data, printer, logger)
- photos_dir = archive_dir / "photos"
- photos_dir.mkdir(parents=True, exist_ok=True)
- timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
- photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
- photo_path = photos_dir / photo_filename
- await asyncio.to_thread(photo_path.write_bytes, frame_data)
- logger.info("[PHOTO-BG] Saved external camera frame: %s", photo_filename)
- else:
- # Check if camera stream is active - use buffered frame to avoid freeze
- # Check both RTSP streams (_active_streams) and chamber image streams (_active_chamber_streams)
- active_for_printer = [k for k in _active_streams if k.startswith(f"{printer_id}-")]
- active_chamber_for_printer = [k for k in _active_chamber_streams if k.startswith(f"{printer_id}-")]
- buffered_frame = get_buffered_frame(printer_id)
- if (active_for_printer or active_chamber_for_printer) and buffered_frame:
- # Use frame from active stream
- logger.info("[PHOTO-BG] Using buffered frame from active stream")
- buffered_frame = _apply_camera_rotation(buffered_frame, printer, logger)
- photos_dir = archive_dir / "photos"
- photos_dir.mkdir(parents=True, exist_ok=True)
- timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
- photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
- photo_path = photos_dir / photo_filename
- await asyncio.to_thread(photo_path.write_bytes, buffered_frame)
- logger.info("[PHOTO-BG] Saved buffered frame: %s", photo_filename)
- else:
- # No active stream - capture new frame
- from backend.app.services.camera import capture_finish_photo
- photo_filename = await capture_finish_photo(
- printer_id=printer_id,
- ip_address=printer.ip_address,
- access_code=printer.access_code,
- model=printer.model,
- archive_dir=archive_dir,
- rotation=getattr(printer, "camera_rotation", 0),
- )
- # Write phase: attach the photo in a fresh short-lived session.
- if photo_filename:
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- arch = await db.get(PrintArchive, archive_id)
- if arch is not None:
- photos = arch.photos or []
- photos.append(photo_filename)
- arch.photos = photos
- await db.commit()
- logger.info("[PHOTO-BG] Saved: %s", photo_filename)
- # The short wait above is bounded so a slow printer can't hold up
- # the print-complete notification, which is what the caller is
- # blocking on. When it ran out with the video still on its way,
- # keep waiting off to the side and add the better frame to the
- # archive once it arrives (#2704 follow-up) — otherwise P1-series
- # users, whose videos routinely take minutes to transfer, never get
- # the pre-bed-drop framing this path exists to provide.
- #
- # Spawned here rather than at the point the wait gave up: both this
- # function and the upgrade do a read-modify-write on `photos`, and
- # the live-camera fallback above can take tens of seconds. Starting
- # the upgrade before that write means the two can interleave and one
- # silently drops the other's entry, leaving a JPEG on disk that the
- # gallery never lists.
- if timelapse_still_pending:
- spawn_background_task(
- _upgrade_finish_photo_from_timelapse(
- archive_id, archive_dir, rotation=getattr(printer, "camera_rotation", 0)
- ),
- name=f"finish-photo-upgrade-{archive_id}",
- )
- return photo_filename
- except Exception as e:
- logger.warning("[PHOTO-BG] Failed: %s", e)
- return None
- finally:
- # #2547: we raised the plate, so we owe the move back down — even if
- # the capture in between threw. Otherwise the user finds the print
- # pinned under the nozzle.
- if plate_restored_z is not None:
- try:
- _park_plate_after_finish_photo(printer_id, plate_restored_z, logger)
- except Exception as e:
- logger.warning("[PLATE-RESTORE] printer %s: could not lower plate: %s", printer_id, e)
- spawn_background_task(_background_energy_calculation(), name="background-energy-calc")
- # Photo capture task - result will be used by notifications
- photo_task = spawn_background_task(_background_finish_photo(), name="background-finish-photo")
- log_timing("Background tasks scheduled (energy, photo)")
- # Also run smart plug, notifications, and maintenance as background tasks
- print_status = data.get("status", "completed")
- async def _background_smart_plug():
- """Handle smart plug automation in background."""
- try:
- logger.info("[AUTO-OFF-BG] Starting smart plug automation for printer %s", printer_id)
- async with async_session() as db:
- await smart_plug_manager.on_print_complete(printer_id, print_status, db)
- logger.info("[AUTO-OFF-BG] Completed")
- except Exception as e:
- logger.warning("[AUTO-OFF-BG] Failed: %s", e)
- async def _background_notifications(finish_photo_filename: str | None = None):
- """Send print complete notifications in background."""
- try:
- logger.info(
- "[NOTIFY-BG] Starting notifications for printer %s, photo=%s", printer_id, finish_photo_filename
- )
- async with async_session() as db:
- from backend.app.models.archive import PrintArchive
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- printer_name = printer.name if printer else f"Printer {printer_id}"
- archive_data = None
- if archive_id:
- archive_result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
- archive = archive_result.scalar_one_or_none()
- if archive:
- # Actual elapsed time from started_at/completed_at when both are
- # populated (every terminal status sets completed_at after #1198).
- # Falls back to None so the notification path can decide whether to
- # render the slicer estimate as a last resort.
- actual_time_seconds = None
- if archive.started_at and archive.completed_at:
- elapsed = (archive.completed_at - archive.started_at).total_seconds()
- if elapsed > 0:
- actual_time_seconds = int(elapsed)
- archive_data = {
- "print_time_seconds": archive.print_time_seconds,
- "actual_time_seconds": actual_time_seconds,
- "actual_filament_grams": archive.filament_used_grams,
- "failure_reason": archive.failure_reason,
- "created_by_id": archive.created_by_id,
- }
- # Scale filament usage for partial prints
- if print_status != "completed" and archive.filament_used_grams:
- progress = data.get("progress") or 0
- scale = _partial_progress_scale(progress)
- archive_data["actual_filament_grams"] = round(archive.filament_used_grams * scale, 1)
- archive_data["progress"] = progress
- # Pass per-slot data from archive.extra_data
- if archive.extra_data and archive.extra_data.get("filament_slots"):
- slots = archive.extra_data["filament_slots"]
- if print_status != "completed":
- scale = _partial_progress_scale(data.get("progress"))
- slots = [{**s, "used_g": round(s["used_g"] * scale, 1)} for s in slots]
- archive_data["filament_slots"] = slots
- # Scope project-summed totals down to the plate that was
- # actually printed — see _scope_notification_archive_data_to_plate
- # for the why (#1785).
- archive_data = _scope_notification_archive_data_to_plate(
- archive_data,
- archive.file_path,
- notify_plate_id,
- print_status,
- data.get("progress"),
- app_settings.base_dir,
- )
- # Enrich filament_grams from usage_results when archive has no 3MF data
- if not archive_data.get("actual_filament_grams") and usage_results:
- total_from_usage = sum(r.get("weight_used", 0) for r in usage_results)
- if total_from_usage > 0:
- archive_data["actual_filament_grams"] = round(total_from_usage, 1)
- # Pass usage tracker results for AMS slot info in notifications
- if usage_results:
- archive_data["usage_results"] = usage_results
- # Add finish photo URL and image bytes if available
- if finish_photo_filename:
- from backend.app.api.routes.settings import get_setting
- external_url = await get_setting(db, "external_url")
- if external_url:
- external_url = external_url.rstrip("/")
- archive_data["finish_photo_url"] = (
- f"{external_url}/api/v1/archives/{archive_id}/photos/{finish_photo_filename}"
- )
- else:
- # Fallback to relative URL (won't work for external services)
- archive_data["finish_photo_url"] = (
- f"/api/v1/archives/{archive_id}/photos/{finish_photo_filename}"
- )
- # Read finish photo bytes for image attachment (e.g. Pushover)
- try:
- from backend.app.utils.archive_paths import find_archive_photo
- photo_path = find_archive_photo(archive, finish_photo_filename)
- if photo_path is not None:
- photo_bytes = await asyncio.to_thread(photo_path.read_bytes)
- if len(photo_bytes) <= 2_500_000:
- archive_data["image_data"] = photo_bytes
- logger.info("[NOTIFY-BG] Loaded finish photo bytes: %s bytes", len(photo_bytes))
- else:
- logger.warning(
- f"[NOTIFY-BG] Finish photo too large for attachment: "
- f"{len(photo_bytes)} bytes"
- )
- except Exception as e:
- logger.warning("[NOTIFY-BG] Failed to read finish photo bytes: %s", e)
- if not await _kill_switch_notification_already_sent(kill_switch_notification_task):
- await notification_service.on_print_complete(
- printer_id, printer_name, print_status, data, db, archive_data=archive_data
- )
- else:
- logger.info("[NOTIFY-BG] Skipped duplicate kill-switch provider notification")
- # Send user-specific email notification
- if archive_data:
- created_by_id = archive_data.get("created_by_id")
- raw_filename = data.get("subtask_name") or data.get("filename", "Unknown")
- await _dispatch_user_print_email(
- print_status,
- created_by_id,
- printer_name,
- raw_filename,
- db,
- )
- logger.info("[NOTIFY-BG] Completed")
- except Exception as e:
- logger.error("[NOTIFY-BG] Failed: %s", e, exc_info=True)
- async def _background_maintenance_check():
- """Check for maintenance due in background."""
- if print_status != "completed":
- return
- try:
- logger.info("[MAINT-BG] Starting maintenance check for printer %s", printer_id)
- async with async_session() as db:
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- printer_name = printer.name if printer else f"Printer {printer_id}"
- await ensure_default_types(db)
- overview = await _get_printer_maintenance_internal(printer_id, db, commit=True)
- items_needing_attention = [
- {"name": item.maintenance_type_name, "is_due": item.is_due, "is_warning": item.is_warning}
- for item in overview.maintenance_items
- if item.enabled and (item.is_due or item.is_warning)
- ]
- if items_needing_attention:
- await notification_service.on_maintenance_due(printer_id, printer_name, items_needing_attention, db)
- logger.info("[MAINT-BG] Sent notification: %s items need attention", len(items_needing_attention))
- # MQTT relay - publish maintenance alerts
- for item in items_needing_attention:
- try:
- await mqtt_relay.on_maintenance_alert(
- printer_id=printer_id,
- printer_name=printer_name,
- maintenance_type=item["name"],
- current_value=0, # Not easily available here
- threshold=0, # Not easily available here
- )
- except Exception:
- pass # Don't fail if MQTT fails
- else:
- logger.info("[MAINT-BG] Completed (no items need attention)")
- except Exception as e:
- logger.warning("[MAINT-BG] Failed: %s", e)
- spawn_background_task(_background_smart_plug(), name="background-smart-plug")
- spawn_background_task(_background_maintenance_check(), name="background-maintenance-check")
- # Notification task waits for photo capture to complete first (with timeout).
- # When a timelapse was recording, photo sourcing polls the per-print
- # timelapse for up to 60s (#1397) — extend the budget so the notification
- # carries the correct bed-up photo instead of falling through to the
- # live-cam grab. Adds ~30s of notification latency at worst on slow links.
- #
- # #2547: both budgets now have to cover a plate restore as well.
- #
- # Without timelapse, the wait is on the moment producer, which raises the
- # plate before its grab — so this has to outlast that producer's own budget.
- #
- # With timelapse, the capture polls up to
- # `_FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS` for the video and only then
- # falls back to a live grab, which is the case that raises the plate. At the
- # old flat 75s that fallback was guaranteed to be cut off mid-settle, so the
- # restore would have moved the plate for a photo nobody waited for.
- photo_wait_timeout = (
- _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS + _FINISH_PHOTO_PRODUCER_WAIT_SECONDS
- if data.get("timelapse_was_active")
- else _FINISH_PHOTO_PRODUCER_WAIT_SECONDS + 15
- )
- async def _photo_then_notify():
- """Wait for photo capture, then send notification with photo URL."""
- finish_photo = None
- try:
- finish_photo = await asyncio.wait_for(photo_task, timeout=photo_wait_timeout)
- logger.info("[PHOTO-NOTIFY] Photo task returned: %s", finish_photo)
- except TimeoutError:
- logger.warning(
- "[PHOTO-NOTIFY] Photo capture timed out after %ss, sending notification without photo",
- photo_wait_timeout,
- )
- except Exception as e:
- logger.warning("[PHOTO-NOTIFY] Photo task failed: %s", e)
- try:
- await _background_notifications(finish_photo)
- except Exception as e:
- logger.error("[PHOTO-NOTIFY] Notification sending failed: %s", e, exc_info=True)
- spawn_background_task(_photo_then_notify(), name="photo-then-notify")
- # Stitch external camera layer timelapse if session was active
- print_status = data.get("status", "completed")
- async def _background_layer_timelapse():
- """Stitch layer timelapse and attach to archive."""
- from backend.app.services.layer_timelapse import cancel_session, on_print_complete as tl_complete
- try:
- if print_status == "completed":
- logger.info("[LAYER-TL] Stitching layer timelapse for printer %s", printer_id)
- timelapse_path = await tl_complete(printer_id)
- if timelapse_path and archive_id:
- logger.info("[LAYER-TL] Attaching timelapse %s to archive %s", timelapse_path, archive_id)
- async with async_session() as db:
- service = ArchiveService(db)
- timelapse_data = await asyncio.to_thread(timelapse_path.read_bytes)
- await service.attach_timelapse(archive_id, timelapse_data, "layer_timelapse.mp4")
- # Clean up the temp file
- await asyncio.to_thread(timelapse_path.unlink, missing_ok=True)
- logger.info("[LAYER-TL] Layer timelapse attached successfully")
- elif timelapse_path:
- # Timelapse created but no archive - just clean up
- await asyncio.to_thread(timelapse_path.unlink, missing_ok=True)
- else:
- # Print failed or cancelled - cancel timelapse session
- cancel_session(printer_id)
- logger.info(
- "[LAYER-TL] Cancelled layer timelapse for printer %s (status: %s)", printer_id, print_status
- )
- except Exception as e:
- logger.warning("[LAYER-TL] Failed: %s", e)
- # Try to cancel session on error
- try:
- cancel_session(printer_id)
- except Exception:
- pass # Best-effort timelapse session cancellation on error
- spawn_background_task(_background_layer_timelapse(), name="background-layer-timelapse")
- log_timing("All background tasks scheduled")
- # Auto-scan for timelapse if recording was active during the print
- if archive_id and data.get("timelapse_was_active") and data.get("status") == "completed":
- logger.info("[TIMELAPSE] Timelapse was active during print, scheduling auto-scan for archive %s", archive_id)
- # Schedule timelapse scan as background task with retries
- # The printer needs time to encode the video after print completion
- baseline = _timelapse_baselines.pop(printer_id, None)
- spawn_background_task(
- _scan_for_timelapse_with_retries(archive_id, baseline),
- name=f"scan-timelapse-{archive_id}",
- )
- log_timing("Timelapse scan scheduled")
- logger.info("[CALLBACK] on_print_complete finished for printer %s, archive %s", printer_id, archive_id)
- # AMS sensor history recording
- _ams_history_task: asyncio.Task | None = None
- AMS_HISTORY_INTERVAL = 300 # Record every 5 minutes
- AMS_HISTORY_RETENTION_DAYS = 30 # Keep data for 30 days
- _ams_cleanup_counter = 0 # Track recordings to trigger periodic cleanup
- # Track alarm cooldowns (printer_id:ams_id:type -> last_alarm_time)
- _ams_alarm_cooldown: dict[str, datetime] = {}
- AMS_ALARM_COOLDOWN_MINUTES = 60 # Don't send same alarm more than once per hour
- def _resolve_temp_alarm_threshold(fair_threshold: float, raw_alarm_value: str | None) -> float:
- """Temperature at which the AMS alarm fires, falling back to the display band.
- ``ams_temp_fair`` decides when the AMS card turns amber. It used to decide
- when a notification was sent as well, which is why a room above it made the
- alarm fire once an hour for as long as the weather lasted -- and the only way
- to stop that was to raise the display band and lose the colour that says the
- unit is warm (#2905).
- Unset resolves to the fair threshold, so an install that never sets one is
- unchanged. Settings storage stringifies ``None`` to the literal ``"None"``,
- so that arrives here as a string and is handled by the same branch as any
- other unparseable value -- there is no separate sentinel to keep in sync.
- A non-positive value is refused rather than honoured: zero would alarm
- permanently, and it is far more likely to be a cleared field than a
- deliberate choice.
- """
- if raw_alarm_value is None:
- return fair_threshold
- try:
- value = float(raw_alarm_value)
- except (TypeError, ValueError):
- return fair_threshold
- if not math.isfinite(value) or value <= 0:
- return fair_threshold
- return value
- # Per-AMS "drying was live at" latch that suppresses the high-temperature alarm
- # through a cycle and the cool-down after it (#1802). Stored in the settings
- # table rather than alongside _ams_alarm_cooldown above, because a restart
- # partway through a cool-down would otherwise resume alarming about heat the
- # user asked for — the same internal-timestamp-row pattern as
- # support.py's debug_logging_enabled_at.
- AMS_DRYING_LATCH_KEY = "ams_drying_alarm_latch"
- # Upper bound on that suppression. The latch normally clears as soon as the unit
- # reads at or below the threshold; see utils.ams_drying for why this cap only
- # matters when it never does.
- AMS_DRYING_GRACE_MINUTES = 120
- async def _load_ams_drying_latch(db) -> dict[str, datetime]:
- """Read the persisted per-AMS drying latch, dropping entries out of window.
- Anything older than the grace cap would expire on its next visit anyway, so
- discarding it here costs nothing and stops rows for deleted printers from
- accumulating.
- Stamps ahead of now get two defences, because a box whose clock jumps
- backwards (a Pi with no RTC coming up before NTP) writes them: wildly future
- ones are discarded outright, and the rest are clamped to now. Without the
- clamp the cap would measure from a moment that has not happened yet and hold
- the alarm quiet for the skew on top of the cap. One unnecessary notification
- after a clock jump is a far better failure than an alarm silently disabled
- for hours.
- """
- from backend.app.models.settings import Settings
- result = await db.execute(select(Settings).where(Settings.key == AMS_DRYING_LATCH_KEY))
- setting = result.scalar_one_or_none()
- if not setting or not setting.value:
- return {}
- try:
- raw = json.loads(setting.value)
- except (ValueError, TypeError):
- return {} # Corrupted row → no latch, alarms behave as they did before
- if not isinstance(raw, dict):
- return {}
- now = datetime.now(timezone.utc)
- window = timedelta(minutes=AMS_DRYING_GRACE_MINUTES)
- latch: dict[str, datetime] = {}
- for key, value in raw.items():
- try:
- stamp = datetime.fromisoformat(str(value))
- except (ValueError, TypeError):
- continue
- if stamp.tzinfo is None:
- stamp = stamp.replace(tzinfo=timezone.utc)
- if not (now - window <= stamp <= now + window):
- continue
- # Nothing may sit in the future: suppression is measured as now minus
- # the stamp, so a stamp ahead of now would extend it by the skew on top
- # of the cap. Clamping the survivors keeps the cap an actual cap.
- latch[str(key)] = min(stamp, now)
- return latch
- async def _save_ams_drying_latch(db, latch: dict[str, datetime]) -> None:
- """Persist the latch, writing only when it actually changed.
- Adds the session change but does not commit — the caller's own commit
- carries it, so the latch lands in the same transaction as the sensor rows
- that produced it.
- """
- from backend.app.models.settings import Settings
- payload = json.dumps({key: stamp.isoformat() for key, stamp in sorted(latch.items())})
- result = await db.execute(select(Settings).where(Settings.key == AMS_DRYING_LATCH_KEY))
- setting = result.scalar_one_or_none()
- if setting is None:
- # Don't create the row on installs that never dry anything.
- if payload != "{}":
- db.add(Settings(key=AMS_DRYING_LATCH_KEY, value=payload))
- elif setting.value != payload:
- setting.value = payload
- def _ams_has_filament(ams_data: dict) -> bool:
- """True if this AMS unit has at least one tray slot holding filament.
- Bambu firmware reports loaded slots via `tray_exist_bits`, a per-AMS hex
- bitmap (one bit per tray slot — bit set = spool present). Empty AMS units
- still report sensor readings, but those readings are ambient and not
- actionable: no filament to dry, no humidity to push down. #1619 — gate
- humidity/temperature alarms on this check so empty units don't generate
- hourly noise. Sensor history still records regardless so the UI charts
- stay continuous.
- Fallback path inspects the `tray` array's `tray_type` fields for setups
- where `tray_exist_bits` is missing (some early-connection pushall shapes).
- """
- bits = ams_data.get("tray_exist_bits")
- if isinstance(bits, str) and bits.strip():
- try:
- return int(bits, 16) > 0
- except ValueError:
- pass
- trays = ams_data.get("tray")
- if isinstance(trays, list):
- return any(
- isinstance(t, dict) and isinstance(t.get("tray_type"), str) and t["tray_type"].strip() for t in trays
- )
- return False
- async def record_ams_history():
- """Background task to record AMS humidity and temperature data."""
- logger = logging.getLogger(__name__)
- # Wait a short time for MQTT connections to establish on startup
- await asyncio.sleep(10)
- while True:
- try:
- from backend.app.models.ams_history import AMSSensorHistory
- from backend.app.models.printer import Printer
- from backend.app.models.settings import Settings
- async with async_session() as db:
- # Get all active printers
- result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
- printers = result.scalars().all()
- # Get alarm thresholds from settings
- humidity_threshold = 60.0 # Default: fair threshold
- temp_fair_threshold = 35.0 # Display band default (ams_temp_fair)
- result = await db.execute(select(Settings).where(Settings.key == "ams_humidity_fair"))
- setting = result.scalar_one_or_none()
- if setting:
- try:
- humidity_threshold = float(setting.value)
- except (ValueError, TypeError):
- pass # Keep default threshold if stored value is invalid
- result = await db.execute(select(Settings).where(Settings.key == "ams_temp_fair"))
- setting = result.scalar_one_or_none()
- if setting:
- try:
- temp_fair_threshold = float(setting.value)
- except (ValueError, TypeError):
- pass # Keep default threshold if stored value is invalid
- # The alarm gets its own threshold, seeded from the resolved fair
- # value so an install that has never set one behaves exactly as
- # it did before (#2905). ams_temp_fair decides when the card turns
- # amber; 35 C is a reasonable place to change a colour and not a
- # reasonable place to page someone. A room above it makes the
- # alarm fire once an hour for as long as the weather lasts, and
- # the only way to stop it was to raise the display band and lose
- # the colour that says the unit is warm.
- #
- # An unset value is stored as the literal "None", which the except
- # below swallows the same way it swallows garbage -- so the
- # fallback costs nothing and needs no sentinel of its own.
- result = await db.execute(select(Settings).where(Settings.key == "ams_temp_alarm"))
- setting = result.scalar_one_or_none()
- temp_alarm_threshold = _resolve_temp_alarm_threshold(
- temp_fair_threshold, setting.value if setting else None
- )
- # Per-filament humidity threshold overrides (#1605) — resolved
- # per-AMS below from the loaded tray types. Reuses the same
- # resolver as the auto-drying scheduler so behavior stays in
- # lockstep across both consumers.
- from backend.app.services.print_scheduler import PrintScheduler
- per_type_humidity_thresholds: dict[str, int] = {}
- result = await db.execute(select(Settings).where(Settings.key == "ams_humidity_thresholds"))
- setting = result.scalar_one_or_none()
- if setting and setting.value:
- try:
- raw = json.loads(setting.value)
- if isinstance(raw, dict):
- for k, v in raw.items():
- try:
- per_type_humidity_thresholds[str(k).upper() if k != "default" else "default"] = int(
- v
- )
- except (TypeError, ValueError):
- continue
- except (ValueError, TypeError):
- pass # Invalid JSON → no overrides, fall through to global threshold
- # Per-AMS drying latch (#1802), loaded once per pass and written
- # back below only if a unit changed it.
- drying_latch = await _load_ams_drying_latch(db)
- drying_latch_before = dict(drying_latch)
- recorded_count = 0
- for printer in printers:
- # Get current state from printer manager
- state = printer_manager.get_status(printer.id)
- if not state or not state.connected or not state.raw_data:
- continue # Skip disconnected printers - don't use stale data
- raw_data = state.raw_data
- if "ams" not in raw_data or not isinstance(raw_data["ams"], list):
- continue
- # Record data for each AMS unit
- for ams_data in raw_data["ams"]:
- ams_id = int(ams_data.get("id", 0))
- # Get humidity (prefer humidity_raw)
- humidity_raw = ams_data.get("humidity_raw")
- humidity_idx = ams_data.get("humidity")
- humidity = None
- if humidity_raw is not None:
- try:
- humidity = float(humidity_raw)
- except (ValueError, TypeError):
- pass # Skip unparseable humidity; will try fallback
- if humidity is None and humidity_idx is not None:
- try:
- humidity = float(humidity_idx)
- except (ValueError, TypeError):
- pass # Skip unparseable humidity index value
- # Get temperature
- temperature = None
- temp_str = ams_data.get("temp")
- if temp_str is not None:
- try:
- temperature = float(temp_str)
- except (ValueError, TypeError):
- pass # Skip unparseable temperature value
- # Skip if no data
- if humidity is None and temperature is None:
- continue
- # Record the data point
- history = AMSSensorHistory(
- printer_id=printer.id,
- ams_id=ams_id,
- humidity=humidity,
- humidity_raw=float(humidity_raw) if humidity_raw else None,
- temperature=temperature,
- )
- db.add(history)
- recorded_count += 1
- # Generate AMS label and determine if it's AMS-HT (A, B, C, D or HT-A for AMS-Lite/Hub)
- is_ams_ht = ams_id >= 128
- if is_ams_ht:
- ams_label = f"HT-{chr(65 + (ams_id - 128))}"
- else:
- ams_label = f"AMS-{chr(65 + ams_id)}"
- # Skip alarm dispatch for empty AMS units — humidity /
- # temperature readings are ambient with no filament to
- # protect, and the hourly notification just becomes
- # noise. Sensor history was already recorded above so
- # the UI charts stay continuous (#1619). Per-AMS check
- # so a multi-AMS setup with one loaded + one empty
- # still alarms on the loaded unit.
- if not _ams_has_filament(ams_data):
- continue
- # Resolve per-filament humidity threshold for this AMS
- # unit (#1605). Falls back to the global ams_humidity_fair
- # when no per-type overrides are configured.
- trays = ams_data.get("tray", []) or []
- effective_humidity_threshold = float(
- PrintScheduler.resolve_humidity_threshold(
- trays, per_type_humidity_thresholds, int(humidity_threshold)
- )
- )
- # Check humidity alarm (only if above threshold)
- if humidity is not None and humidity > effective_humidity_threshold:
- cooldown_key = f"{printer.id}:{ams_id}:humidity"
- last_alarm = _ams_alarm_cooldown.get(cooldown_key)
- now = datetime.now(timezone.utc)
- if (
- last_alarm is None
- or (now - last_alarm).total_seconds() >= AMS_ALARM_COOLDOWN_MINUTES * 60
- ):
- _ams_alarm_cooldown[cooldown_key] = now
- logger.info(
- f"Sending humidity alarm for {printer.name} {ams_label}: {humidity}% > {effective_humidity_threshold}%"
- )
- try:
- # Call different notification method based on AMS type
- if is_ams_ht:
- await notification_service.on_ams_ht_humidity_high(
- printer.id,
- printer.name,
- ams_label,
- humidity,
- effective_humidity_threshold,
- db,
- )
- else:
- await notification_service.on_ams_humidity_high(
- printer.id,
- printer.name,
- ams_label,
- humidity,
- effective_humidity_threshold,
- db,
- )
- except Exception as e:
- logger.warning("Failed to send humidity alarm: %s", e)
- # A drying cycle heats the unit far past ams_temp_fair on
- # purpose — 45 C for PLA, 65 C for PETG, 85 C on an
- # AMS-HT, against a 35 C default — so the alarm fired
- # once an hour for the whole cycle and kept firing while
- # the unit cooled back down (#1802). Latch on the
- # firmware's own drying state and hold until the reading
- # returns to normal. Humidity is deliberately left alone:
- # it falls during drying, which is the whole point.
- latch_key = f"{printer.id}:{ams_id}"
- # The latch releases at `threshold`, so it takes the alarm
- # number too. Handing it the display band would strand the
- # latch on any unit that settles back above it -- a room
- # where the AMS rests at 37.7 C never returns under a 35 C
- # band, so the latch could only expire on the grace cap
- # rather than releasing when the unit had actually cooled.
- suppress_temp_alarm, new_latch = temperature_alarm_suppressed(
- drying_active=is_drying_active(ams_data),
- temperature=temperature,
- threshold=temp_alarm_threshold,
- latched_at=drying_latch.get(latch_key),
- now=datetime.now(timezone.utc),
- grace_minutes=AMS_DRYING_GRACE_MINUTES,
- )
- if new_latch is None:
- drying_latch.pop(latch_key, None)
- else:
- drying_latch[latch_key] = new_latch
- # Check temperature alarm (only if above threshold)
- if temperature is not None and temperature > temp_alarm_threshold and not suppress_temp_alarm:
- cooldown_key = f"{printer.id}:{ams_id}:temperature"
- last_alarm = _ams_alarm_cooldown.get(cooldown_key)
- now = datetime.now(timezone.utc)
- if (
- last_alarm is None
- or (now - last_alarm).total_seconds() >= AMS_ALARM_COOLDOWN_MINUTES * 60
- ):
- _ams_alarm_cooldown[cooldown_key] = now
- logger.info(
- f"Sending temperature alarm for {printer.name} {ams_label}: "
- f"{temperature}°C > {temp_alarm_threshold}°C"
- )
- try:
- # Call different notification method based on AMS type
- if is_ams_ht:
- # The reported threshold has to be the one
- # that fired, or the message says "> 35 °C"
- # while firing at 45.
- await notification_service.on_ams_ht_temperature_high(
- printer.id, printer.name, ams_label, temperature, temp_alarm_threshold, db
- )
- else:
- await notification_service.on_ams_temperature_high(
- printer.id, printer.name, ams_label, temperature, temp_alarm_threshold, db
- )
- except Exception as e:
- logger.warning("Failed to send temperature alarm: %s", e)
- if drying_latch != drying_latch_before:
- await _save_ams_drying_latch(db, drying_latch)
- await db.commit()
- if recorded_count > 0:
- logger.info("Recorded %s AMS sensor history entries", recorded_count)
- # Periodic cleanup of old data (every ~288 recordings = ~24 hours at 5min interval)
- global _ams_cleanup_counter
- _ams_cleanup_counter += 1
- if _ams_cleanup_counter >= 288:
- _ams_cleanup_counter = 0
- # Get retention days from settings
- from backend.app.models.settings import Settings
- result = await db.execute(select(Settings).where(Settings.key == "ams_history_retention_days"))
- setting = result.scalar_one_or_none()
- retention_days = int(setting.value) if setting else AMS_HISTORY_RETENTION_DAYS
- cutoff = utcnow_naive() - timedelta(days=retention_days)
- result = await db.execute(delete(AMSSensorHistory).where(AMSSensorHistory.recorded_at < cutoff))
- await db.commit()
- if result.rowcount > 0:
- logger.info(
- f"Cleaned up {result.rowcount} old AMS sensor history entries (older than {retention_days} days)"
- )
- # Wait until next recording interval
- await asyncio.sleep(AMS_HISTORY_INTERVAL)
- except asyncio.CancelledError:
- break
- except Exception as e:
- logger.warning("AMS history recording failed: %s", e)
- await asyncio.sleep(60) # Wait a bit before retrying
- def start_ams_history_recording():
- """Start the AMS history recording background task."""
- global _ams_history_task
- if _ams_history_task is None:
- _ams_history_task = asyncio.create_task(record_ams_history())
- logging.getLogger(__name__).info("AMS history recording started")
- def stop_ams_history_recording():
- """Stop the AMS history recording background task."""
- global _ams_history_task
- if _ams_history_task:
- _ams_history_task.cancel()
- _ams_history_task = None
- logging.getLogger(__name__).info("AMS history recording stopped")
- # Printer sensor history recording (nozzle / bed / chamber)
- _printer_sensor_history_task: asyncio.Task | None = None
- PRINTER_SENSOR_HISTORY_INTERVAL = 60 # Record every minute — heaters move faster than AMS humidity
- PRINTER_SENSOR_HISTORY_RETENTION_DAYS = 30
- _printer_sensor_cleanup_counter = 0
- # Sensor kinds tracked in state.temperatures — these are the normalised keys the
- # MQTT parser writes, so we don't need to handle per-model field aliases here
- # (nozzle_temper / left_nozzle_temper / right_nozzle_temper / chamber_temper
- # are all collapsed by services/bambu_mqtt.py before they reach this loop).
- _SENSOR_KINDS = ("nozzle", "nozzle_2", "bed", "chamber")
- _SENSOR_TARGET_KEYS = {
- "nozzle": "nozzle_target",
- "nozzle_2": "nozzle_2_target",
- "bed": "bed_target",
- "chamber": "chamber_target",
- }
- async def record_printer_sensor_history():
- """Background task to record nozzle / bed / chamber readings.
- Pulls from `state.temperatures` (already normalised across all printer
- models by the MQTT parser) rather than re-parsing raw_data, so we get
- free coverage of dual-nozzle H2D, sensor-only X1C chamber, etc.
- """
- logger = logging.getLogger(__name__)
- await asyncio.sleep(10)
- while True:
- try:
- from backend.app.models.printer import Printer
- from backend.app.models.printer_sensor_history import PrinterSensorHistory
- from backend.app.models.settings import Settings
- async with async_session() as db:
- result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
- printers = result.scalars().all()
- recorded_count = 0
- for printer in printers:
- state = printer_manager.get_status(printer.id)
- if not state or not state.connected:
- continue
- temps = getattr(state, "temperatures", None) or {}
- if not isinstance(temps, dict):
- continue
- for kind in _SENSOR_KINDS:
- if kind not in temps:
- continue
- try:
- value = float(temps[kind])
- except (ValueError, TypeError):
- continue
- target_raw = temps.get(_SENSOR_TARGET_KEYS[kind])
- target_val: float | None = None
- if target_raw is not None:
- try:
- target_val = float(target_raw)
- except (ValueError, TypeError):
- target_val = None
- db.add(
- PrinterSensorHistory(
- printer_id=printer.id,
- sensor_kind=kind,
- value=value,
- target=target_val,
- )
- )
- recorded_count += 1
- await db.commit()
- if recorded_count > 0:
- logger.debug("Recorded %s printer sensor history entries", recorded_count)
- # Periodic cleanup — once every ~24h at this interval.
- global _printer_sensor_cleanup_counter
- _printer_sensor_cleanup_counter += 1
- cleanup_every = max(1, (24 * 60 * 60) // PRINTER_SENSOR_HISTORY_INTERVAL)
- if _printer_sensor_cleanup_counter >= cleanup_every:
- _printer_sensor_cleanup_counter = 0
- result = await db.execute(
- select(Settings).where(Settings.key == "printer_sensor_history_retention_days")
- )
- setting = result.scalar_one_or_none()
- retention_days = int(setting.value) if setting else PRINTER_SENSOR_HISTORY_RETENTION_DAYS
- cutoff = utcnow_naive() - timedelta(days=retention_days)
- cleanup = await db.execute(
- delete(PrinterSensorHistory).where(PrinterSensorHistory.recorded_at < cutoff)
- )
- await db.commit()
- if cleanup.rowcount > 0:
- logger.info(
- "Cleaned up %s old printer sensor history entries (older than %s days)",
- cleanup.rowcount,
- retention_days,
- )
- await asyncio.sleep(PRINTER_SENSOR_HISTORY_INTERVAL)
- except asyncio.CancelledError:
- break
- except Exception as e:
- logger.warning("Printer sensor history recording failed: %s", e)
- await asyncio.sleep(60)
- def start_printer_sensor_history_recording():
- global _printer_sensor_history_task
- if _printer_sensor_history_task is None:
- _printer_sensor_history_task = asyncio.create_task(record_printer_sensor_history())
- logging.getLogger(__name__).info("Printer sensor history recording started")
- def stop_printer_sensor_history_recording():
- global _printer_sensor_history_task
- if _printer_sensor_history_task:
- _printer_sensor_history_task.cancel()
- _printer_sensor_history_task = None
- logging.getLogger(__name__).info("Printer sensor history recording stopped")
- # Printer runtime tracking
- _runtime_tracking_task: asyncio.Task | None = None
- RUNTIME_TRACKING_INTERVAL = 30 # Update every 30 seconds
- async def track_printer_runtime():
- """Background task to track printer active runtime (RUNNING state only).
- PAUSE is intentionally excluded — the runtime counter feeds hours-based
- maintenance intervals (rod lubrication, belt checks, nozzle cleaning)
- which track mechanical wear. Pause time has no motion and no wear, so
- counting it inflates maintenance warnings (#1521).
- """
- logger = logging.getLogger(__name__)
- # Wait for MQTT connections to establish on startup
- await asyncio.sleep(15)
- while True:
- try:
- from backend.app.models.printer import Printer
- # Fetch printer IDs in a short-lived read-only session
- async with async_session() as db:
- result = await db.execute(
- select(Printer.id, Printer.name, Printer.runtime_seconds, Printer.last_runtime_update).where(
- Printer.is_active.is_(True)
- )
- )
- printer_rows = result.all()
- now = datetime.now(timezone.utc)
- updated_count = 0
- # Update each printer in its own short session to minimise write-lock
- # hold time and avoid blocking critical commits like queue status
- # updates (#897).
- for pid, pname, runtime_secs, last_update in printer_rows:
- state = printer_manager.get_status(pid)
- if not state:
- logger.debug("[%s] Runtime tracking: no state available", pname)
- continue
- if not state.connected:
- logger.debug("[%s] Runtime tracking: not connected", pname)
- continue
- needs_commit = False
- new_runtime = runtime_secs
- new_last_update = last_update
- if state.state == "RUNNING":
- if last_update:
- lu = last_update if last_update.tzinfo else last_update.replace(tzinfo=timezone.utc)
- elapsed = (now - lu).total_seconds()
- if elapsed > 0:
- new_runtime = runtime_secs + int(elapsed)
- updated_count += 1
- needs_commit = True
- logger.debug(
- f"[{pname}] Runtime tracking: added {int(elapsed)}s, "
- f"total={new_runtime}s ({new_runtime / 3600:.2f}h)"
- )
- else:
- needs_commit = True
- logger.debug("[%s] Runtime tracking: first active detection", pname)
- new_last_update = now
- else:
- if last_update is not None:
- logger.debug(f"[{pname}] Runtime tracking: state={state.state}, clearing last_runtime_update")
- new_last_update = None
- needs_commit = True
- if needs_commit:
- try:
- async with async_session() as db:
- result = await db.execute(select(Printer).where(Printer.id == pid))
- printer = result.scalar_one_or_none()
- if printer:
- printer.runtime_seconds = new_runtime
- printer.last_runtime_update = new_last_update
- await db.commit()
- except Exception as e:
- logger.warning("[%s] Runtime tracking commit failed: %s", pname, e)
- if updated_count > 0:
- logger.debug("Updated runtime for %s printer(s)", updated_count)
- except asyncio.CancelledError:
- logger.info("Runtime tracking cancelled")
- break
- except Exception as e:
- logger.warning("Runtime tracking failed: %s", e)
- await asyncio.sleep(RUNTIME_TRACKING_INTERVAL)
- def start_runtime_tracking():
- """Start the printer runtime tracking background task."""
- global _runtime_tracking_task
- if _runtime_tracking_task is None:
- _runtime_tracking_task = asyncio.create_task(track_printer_runtime())
- logging.getLogger(__name__).info("Printer runtime tracking started")
- def stop_runtime_tracking():
- """Stop the printer runtime tracking background task."""
- global _runtime_tracking_task
- if _runtime_tracking_task:
- _runtime_tracking_task.cancel()
- _runtime_tracking_task = None
- logging.getLogger(__name__).info("Printer runtime tracking stopped")
- # SpoolBuddy device watchdog
- _spoolbuddy_watchdog_task: asyncio.Task | None = None
- SPOOLBUDDY_WATCHDOG_INTERVAL = 15
- async def _spoolbuddy_watchdog_loop():
- """Periodic check for SpoolBuddy devices that have gone offline."""
- from backend.app.api.routes.spoolbuddy import spoolbuddy_watchdog
- while True:
- try:
- await spoolbuddy_watchdog()
- except asyncio.CancelledError:
- break
- except Exception as e:
- logging.getLogger(__name__).warning("SpoolBuddy watchdog failed: %s", e)
- await asyncio.sleep(SPOOLBUDDY_WATCHDOG_INTERVAL)
- def start_spoolbuddy_watchdog():
- global _spoolbuddy_watchdog_task
- if _spoolbuddy_watchdog_task is None:
- _spoolbuddy_watchdog_task = asyncio.create_task(_spoolbuddy_watchdog_loop())
- logging.getLogger(__name__).info("SpoolBuddy watchdog started")
- def stop_spoolbuddy_watchdog():
- global _spoolbuddy_watchdog_task
- if _spoolbuddy_watchdog_task:
- _spoolbuddy_watchdog_task.cancel()
- _spoolbuddy_watchdog_task = None
- logging.getLogger(__name__).info("SpoolBuddy watchdog stopped")
- # Dead-MQTT-session recovery
- #
- # check_staleness() covers the "connected but silent" half-broken session. It
- # does nothing once ``state.connected`` is False, and paho's own auto-reconnect
- # is the only thing left watching at that point. When paho stops making
- # progress there is no backstop at all: the #2732 bundle has a P1S drop on a
- # keep-alive timeout at 02:19 and not reconnect until 11:24 — nine hours
- # offline with the UI open the whole time, recovered only when something
- # happened to nudge it.
- #
- # This loop is that backstop. It only touches printers that had a working
- # session and lost it, and only when the MQTT port still answers — a printer
- # that is simply switched off is left to paho, since rebuilding a client
- # against an unreachable host achieves nothing and would fill the log every
- # night.
- _connection_watchdog_task: asyncio.Task | None = None
- CONNECTION_WATCHDOG_INTERVAL = 60
- # How long a printer must have been silent before we stop trusting paho.
- # Comfortably above STALE_TIMEOUT (60 s) and the max reconnect backoff (30 s),
- # so a session that is recovering on its own is never interrupted.
- CONNECTION_WATCHDOG_OFFLINE_GRACE = 300
- # Per-printer floor between rebuild attempts.
- CONNECTION_WATCHDOG_RETRY_INTERVAL = 300
- _connection_watchdog_last_attempt: dict[int, float] = {}
- async def _recover_dead_printer_sessions() -> int:
- """Rebuild MQTT clients that have been offline too long to still be trying.
- Returns the number of printers a rebuild was attempted for (for tests and
- for the caller's logging). Never raises: one unreachable printer must not
- stop the sweep for the rest of the farm.
- """
- logger = logging.getLogger(__name__)
- from backend.app.services.printer_diagnostic import PORT_MQTT, check_port
- now = time.monotonic()
- recovered = 0
- for printer_id, client in list(printer_manager._clients.items()):
- try:
- if client.state.connected:
- _connection_watchdog_last_attempt.pop(printer_id, None)
- continue
- # Time since the last inbound message is the age of the last known
- # good session — no extra bookkeeping needed, and it is the same
- # clock is_stale() reads. 0 means this client has never had one:
- # that is the initial-connect path, where paho retrying is the
- # correct and only behaviour, so leave it be.
- last_msg = client._last_message_time
- if not last_msg:
- continue
- offline_for = time.time() - last_msg
- if offline_for < CONNECTION_WATCHDOG_OFFLINE_GRACE:
- continue
- last_attempt = _connection_watchdog_last_attempt.get(printer_id)
- if last_attempt is not None and now - last_attempt < CONNECTION_WATCHDOG_RETRY_INTERVAL:
- continue
- if not await check_port(client.ip_address, PORT_MQTT):
- # Switched off, unplugged, or off the network. Paho's retry is
- # the right handler; say so at debug level and move on.
- logger.debug(
- "[#2732] Printer %s offline for %.0fs and its MQTT port is not answering "
- "— leaving the reconnect to paho",
- printer_id,
- offline_for,
- )
- _connection_watchdog_last_attempt[printer_id] = now
- continue
- _connection_watchdog_last_attempt[printer_id] = now
- recovered += 1
- logger.warning(
- "[#2732] Printer %s has been offline for %.0fs but answers on MQTT port %d — "
- "rebuilding the client with a fresh session (last connect error: %s)",
- printer_id,
- offline_for,
- PORT_MQTT,
- client.last_connect_error or "none recorded",
- )
- # Async context, so this takes the hard-reset path: fresh client_id,
- # paho's QoS 1 queue dropped. That matters — a project_file left
- # unacked on the dead session would otherwise replay into the new
- # one and trip 0500_4003 on the printer (#1136).
- client.force_reconnect_stale_session(f"offline for {offline_for:.0f}s, port still answering")
- except Exception as e:
- logger.warning("[#2732] Connection watchdog failed for printer %s: %s", printer_id, e)
- return recovered
- async def _connection_watchdog_loop():
- logger = logging.getLogger(__name__)
- # Let the initial connects settle before judging anyone offline.
- await asyncio.sleep(CONNECTION_WATCHDOG_OFFLINE_GRACE)
- while True:
- try:
- await _recover_dead_printer_sessions()
- except asyncio.CancelledError:
- break
- except Exception as e:
- logger.warning("Connection watchdog sweep failed: %s", e)
- await asyncio.sleep(CONNECTION_WATCHDOG_INTERVAL)
- def start_connection_watchdog():
- global _connection_watchdog_task
- if _connection_watchdog_task is None:
- _connection_watchdog_task = asyncio.create_task(_connection_watchdog_loop())
- logging.getLogger(__name__).info("Printer connection watchdog started")
- def stop_connection_watchdog():
- global _connection_watchdog_task
- if _connection_watchdog_task:
- _connection_watchdog_task.cancel()
- _connection_watchdog_task = None
- _connection_watchdog_last_attempt.clear()
- logging.getLogger(__name__).info("Printer connection watchdog stopped")
- # Camera stream orphan cleanup
- _camera_cleanup_task: asyncio.Task | None = None
- CAMERA_CLEANUP_INTERVAL = 60
- async def _camera_cleanup_loop():
- """Periodically clean up orphaned ffmpeg processes."""
- from backend.app.api.routes.camera import cleanup_orphaned_streams
- while True:
- try:
- await cleanup_orphaned_streams()
- except asyncio.CancelledError:
- break
- except Exception as e:
- logging.getLogger(__name__).warning("Camera stream cleanup failed: %s", e)
- await asyncio.sleep(CAMERA_CLEANUP_INTERVAL)
- def start_camera_cleanup():
- global _camera_cleanup_task
- if _camera_cleanup_task is None:
- _camera_cleanup_task = asyncio.create_task(_camera_cleanup_loop())
- logging.getLogger(__name__).info("Camera stream cleanup started")
- def stop_camera_cleanup():
- global _camera_cleanup_task
- if _camera_cleanup_task:
- _camera_cleanup_task.cancel()
- _camera_cleanup_task = None
- logging.getLogger(__name__).info("Camera stream cleanup stopped")
- # ---------------------------------------------------------------------------
- # Expected-print TTL eviction
- # ---------------------------------------------------------------------------
- def _evict_stale_expected_prints() -> None:
- """Remove entries from _expected_prints / _expected_print_creators that are
- older than _EXPECTED_PRINT_TTL_SECONDS.
- This prevents unbounded growth when a print is registered (via
- register_expected_print) but on_print_start never fires — e.g. because the
- printer disconnects, the app restarts, or the print is started directly from
- the printer panel without going through the queue.
- """
- # Use monotonic time so the TTL is unaffected by system clock adjustments
- # (e.g. NTP sync, DST changes).
- cutoff = time.monotonic() - _EXPECTED_PRINT_TTL_SECONDS
- stale_keys = [k for k, t in _expected_print_registered_at.items() if t < cutoff]
- if not stale_keys:
- return
- evicted_archive_ids: set[int] = set()
- for key in stale_keys:
- archive_id = _expected_prints.pop(key, None)
- if archive_id is not None:
- evicted_archive_ids.add(archive_id)
- _expected_print_creators.pop(key, None)
- _expected_print_registered_at.pop(key, None)
- # Also clean up _print_ams_mappings and _print_plate_ids for archive_ids
- # that have no remaining live keys in _expected_prints (all variants
- # were just evicted).
- live_archive_ids = set(_expected_prints.values())
- for archive_id in evicted_archive_ids:
- if archive_id not in live_archive_ids:
- _print_ams_mappings.pop(archive_id, None)
- _print_cost_center_ids.pop(archive_id, None)
- _print_plate_ids.pop(archive_id, None)
- logging.getLogger(__name__).info(
- "Evicted %d stale expected-print entries (TTL=%ds)", len(stale_keys), _EXPECTED_PRINT_TTL_SECONDS
- )
- async def _expected_prints_cleanup_loop() -> None:
- """Background task: periodically evict stale expected-print entries."""
- while True:
- try:
- _evict_stale_expected_prints()
- except asyncio.CancelledError:
- raise
- except Exception as e:
- logging.getLogger(__name__).warning("Expected prints cleanup failed: %s", e)
- await asyncio.sleep(_EXPECTED_PRINT_CLEANUP_INTERVAL)
- def start_expected_prints_cleanup() -> None:
- global _expected_prints_cleanup_task
- if _expected_prints_cleanup_task is None:
- _expected_prints_cleanup_task = asyncio.create_task(_expected_prints_cleanup_loop())
- logging.getLogger(__name__).info("Expected prints cleanup started")
- def stop_expected_prints_cleanup() -> None:
- global _expected_prints_cleanup_task
- if _expected_prints_cleanup_task:
- _expected_prints_cleanup_task.cancel()
- _expected_prints_cleanup_task = None
- logging.getLogger(__name__).info("Expected prints cleanup stopped")
- # ---------------------------------------------------------------------------
- # L-2: Periodic auth-token cleanup (stale TOTP + expired revoked JTIs)
- # ---------------------------------------------------------------------------
- _auth_cleanup_task: asyncio.Task | None = None
- _AUTH_CLEANUP_INTERVAL = 3600 # seconds (hourly)
- async def _run_auth_cleanup() -> None:
- """Single cleanup pass: remove stale TOTP records, expired revoked JTIs, and old rate-limit events."""
- from backend.app.core.database import async_session
- from backend.app.models.auth_ephemeral import AuthEphemeralToken, AuthRateLimitEvent
- from backend.app.models.user_totp import UserTOTP
- now = datetime.now(timezone.utc)
- # Remove unconfirmed (is_enabled=False) TOTP records older than 1 hour.
- try:
- async with async_session() as db:
- stale_cutoff = now - timedelta(hours=1)
- result = await db.execute(
- select(UserTOTP).where(
- UserTOTP.is_enabled.is_(False),
- UserTOTP.created_at < stale_cutoff,
- )
- )
- stale_records = result.scalars().all()
- if stale_records:
- for rec in stale_records:
- await db.delete(rec)
- await db.commit()
- logging.info("Auth cleanup: removed %d stale unconfirmed TOTP record(s)", len(stale_records))
- except Exception as e:
- logging.warning("Auth cleanup: failed to purge stale TOTP records: %s", e)
- # Remove expired revoked-JTI entries (they are no longer needed once the
- # original token's exp has passed — the token would be rejected by JWT
- # signature verification regardless).
- try:
- async with async_session() as db:
- await db.execute(
- delete(AuthEphemeralToken).where(
- AuthEphemeralToken.token_type == "revoked_jti",
- AuthEphemeralToken.expires_at < now,
- )
- )
- await db.commit()
- except Exception as e:
- logging.warning("Auth cleanup: failed to purge expired revoked JTIs: %s", e)
- # L-R6-B: Purge AuthRateLimitEvent rows older than the lockout window (15 min).
- # Events outside this window can never affect rate-limit decisions — they only
- # consume DB space. Use the same window constant as the rate limiter so the
- # two are always in sync.
- try:
- from backend.app.api.routes.mfa import LOCKOUT_WINDOW
- async with async_session() as db:
- await db.execute(
- delete(AuthRateLimitEvent).where(
- AuthRateLimitEvent.occurred_at < now - LOCKOUT_WINDOW,
- )
- )
- await db.commit()
- except Exception as e:
- logging.warning("Auth cleanup: failed to purge stale rate-limit events: %s", e)
- async def _auth_cleanup_loop() -> None:
- """Periodic background task: run auth cleanup every hour."""
- while True:
- try:
- await _run_auth_cleanup()
- except asyncio.CancelledError:
- break
- except Exception as e:
- logging.warning("Auth cleanup loop error: %s", e)
- await asyncio.sleep(_AUTH_CLEANUP_INTERVAL)
- def start_auth_cleanup() -> None:
- global _auth_cleanup_task
- if _auth_cleanup_task is None:
- _auth_cleanup_task = asyncio.create_task(_auth_cleanup_loop())
- logging.getLogger(__name__).info("Auth periodic cleanup started")
- def stop_auth_cleanup() -> None:
- global _auth_cleanup_task
- if _auth_cleanup_task:
- _auth_cleanup_task.cancel()
- _auth_cleanup_task = None
- logging.getLogger(__name__).info("Auth periodic cleanup stopped")
- @asynccontextmanager
- async def lifespan(app: FastAPI):
- # Startup
- # Install Windows-only asyncio Proactor cleanup-RST filter (#1113) before
- # anything else can spawn tasks that might trip it.
- from backend.app.core.asyncio_handlers import install_proactor_reset_filter
- install_proactor_reset_filter()
- await init_db()
- # Browser download tokens expire after five minutes. Remove abandoned
- # prepared ZIPs at startup as well as before each new preparation so a
- # quiet appliance cannot retain an unusable bundle indefinitely.
- try:
- from backend.app.services.printer_media import prune_stale_printer_file_bundles
- await prune_stale_printer_file_bundles()
- except Exception as exc:
- logging.warning("Failed to prune stale printer download bundles: %s", exc)
- # After migrations, so the is_env_managed column exists. Never raises --
- # a bad BAMBUDDY_OIDC_* value is logged and skipped rather than blocking
- # startup (see apply_env_oidc_provider).
- from backend.app.core.oidc_env import apply_env_oidc_provider
- async with async_session() as oidc_db:
- await apply_env_oidc_provider(oidc_db)
- # Close out batches that finished before `completed` was a reachable status
- # (#342). Without this the Batches tab opens on every batch created since
- # the feature shipped, all still marked active. Never blocks startup.
- try:
- from backend.app.services.print_batch import backfill_batch_statuses
- async with async_session() as batch_db:
- await backfill_batch_statuses(batch_db)
- except Exception as exc:
- logging.warning("[BATCH] Startup status backfill failed: %s", exc)
- # Register an app-scoped httpx client for Bambu Cloud services so
- # per-request BambuCloudService instances reuse the same connection pool
- # (important for routes like /cloud/filament-info that chain many
- # get_setting_detail calls). The shared client stores no region/token
- # state, so the per-request ownership pattern that fixed the region-bleed
- # bug is preserved.
- import httpx as _httpx
- from backend.app.services.bambu_cloud import set_shared_http_client
- from backend.app.services.makerworld import (
- set_shared_http_client as set_shared_makerworld_http_client,
- )
- from backend.app.services.orca_cloud import (
- set_shared_http_client as set_shared_orca_http_client,
- )
- _shared_cloud_http_client = _httpx.AsyncClient(timeout=30.0)
- set_shared_http_client(_shared_cloud_http_client)
- # Reuse the same connection pool for MakerWorld — different host, same
- # keep-alive pool saves a TLS handshake per request.
- set_shared_makerworld_http_client(_shared_cloud_http_client)
- # Same for Orca Cloud — without this the per-request OrcaCloudService()
- # each spun up (and never closed) its own client, leaking sockets.
- set_shared_orca_http_client(_shared_cloud_http_client)
- # Fix queue items stuck with invalid "aborted" status (should be "cancelled").
- # This can happen when a print was cancelled mid-print on versions before this fix.
- try:
- async with async_session() as db:
- from backend.app.models.print_queue import PrintQueueItem
- result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.status == "aborted"))
- aborted_items = result.scalars().all()
- if aborted_items:
- for item in aborted_items:
- item.status = "cancelled"
- await db.commit()
- logging.info("Fixed %d queue item(s) with invalid 'aborted' status → 'cancelled'", len(aborted_items))
- except Exception as e:
- logging.warning("Failed to fix aborted queue items: %s", e)
- # Restore debug logging state from previous session
- await init_debug_logging()
- # Set up printer manager callbacks
- loop = asyncio.get_event_loop()
- printer_manager.set_event_loop(loop)
- printer_manager.set_status_change_callback(on_printer_status_change)
- printer_manager.set_print_start_callback(on_print_start)
- printer_manager.set_print_complete_callback(on_print_complete)
- printer_manager.set_print_running_observed_callback(on_print_running_observed)
- printer_manager.set_finish_photo_moment_callback(on_finish_photo_moment)
- printer_manager.set_ams_change_callback(on_ams_change)
- printer_manager.set_fts_inlet_change_callback(on_fts_inlet_change)
- # Rehydrate persisted awaiting-plate-clear gate (#961) so prompts survive restarts
- await printer_manager.load_awaiting_plate_clear_from_db()
- # Layer change callback for external camera timelapse
- async def on_layer_change(printer_id: int, layer_num: int):
- """Capture timelapse frame on layer change + first layer notification."""
- from backend.app.services.layer_timelapse import on_layer_change as tl_layer_change
- await tl_layer_change(printer_id, layer_num)
- # #1867: bank a recent in-print frame so the finish-photo path has a
- # pre-End-G-code image to use instead of a live grab of a swapped plate.
- # #2547 added `on_print_progress` as a second driver — this one alone
- # stops firing once the final layer begins.
- await _maybe_bank_inprint_frame(printer_id, layer_num)
- # First layer complete notification (layer_num >= 2 means layer 1 is done).
- # Gate on actual printing state — Bambu firmware ticks layer_num during
- # the pre-print calibration sequence (homing / mesh-level / bed scan /
- # nozzle clean), so a bare layer_num check can fire minutes before the
- # first real extrusion. We require gcode_state == RUNNING and
- # mc_print_sub_stage in (0 = "Printing", None) so calibration sub-stages
- # (1, 9, 14, ...) are excluded. The window widens to [2, 10] because if
- # the layer counter advanced past 2 during PREPARE, the next on_layer_change
- # edge fires later; _first_layer_notified stays clear until we actually send
- # so a deferred re-evaluation can win. See issue #1837.
- if 2 <= layer_num <= 10 and not _first_layer_notified.get(printer_id, False):
- client = printer_manager.get_client(printer_id)
- state = client.state if client else None
- if not state or state.state != "RUNNING":
- return
- if state.mc_print_sub_stage not in (None, 0):
- return
- _first_layer_notified[printer_id] = True
- try:
- async with async_session() as db:
- from backend.app.models.printer import Printer
- result = await db.execute(select(Printer).where(Printer.id == printer_id))
- printer = result.scalar_one_or_none()
- if not printer:
- return
- printer_name = printer.name
- filename = (state.subtask_name or state.gcode_file or "Unknown") if state else "Unknown"
- total_layers = state.total_layers if state else 0
- image_data = await _capture_snapshot_for_notification(
- printer_id, printer, logging.getLogger(__name__)
- )
- await notification_service.on_first_layer_complete(
- printer_id, printer_name, filename, total_layers, db, image_data=image_data
- )
- except Exception as e:
- logging.getLogger(__name__).warning("First layer notification failed: %s", e)
- printer_manager.set_layer_change_callback(on_layer_change)
- async def on_print_progress(printer_id: int, percent: int):
- """#2547: keep the in-print frame bank fresh through the final layer.
- `on_layer_change` stops the moment the last layer starts, which on the
- H2C capture that closed #2547 left the bank stale for the three minutes
- that layer took. Progress is the only field that keeps advancing there,
- and it freezes before the End G-code runs — so banking on it stays
- inside the print and never sees a swapped plate.
- """
- client = printer_manager.get_client(printer_id)
- state = client.state if client else None
- await _maybe_bank_inprint_frame(printer_id, state.layer_num if state else 0)
- printer_manager.set_print_progress_callback(on_print_progress)
- # Event-driven bed cooldown: fires whenever bed_temper arrives via MQTT
- async def on_bed_temp_update(printer_id: int, bed_temp: float):
- waiter = _bed_cool_waiters.get(printer_id)
- if not waiter:
- return
- threshold = waiter["threshold"]
- if bed_temp > threshold:
- return
- # Bed is at or below threshold — fire notification and remove waiter
- waiter_info = _bed_cool_waiters.pop(printer_id, None)
- if not waiter_info:
- return # Another callback already handled it
- bed_cool_logger = logging.getLogger(__name__)
- bed_cool_logger.info(
- "[BED-COOL] Bed cooled to %.1f°C on printer %s (threshold: %.0f°C)",
- bed_temp,
- printer_id,
- threshold,
- )
- try:
- printer_info = printer_manager.get_printer(printer_id)
- p_name = printer_info.name if printer_info else "Unknown"
- async with async_session() as db:
- await notification_service.on_bed_cooled(
- printer_id=printer_id,
- printer_name=p_name,
- bed_temp=bed_temp,
- threshold=threshold,
- filename=waiter_info["filename"],
- db=db,
- )
- except Exception as e:
- bed_cool_logger.warning("[BED-COOL] Failed to send notification: %s", e)
- printer_manager.set_bed_temp_update_callback(on_bed_temp_update)
- async def on_drying_complete(printer_id: int, ams_id: int):
- """Smart-plug auto-off-after-drying trigger (#1349).
- Fires once per AMS unit when ``dry_time`` falls from >0 to 0. The
- manager walks all plugs linked to this printer and turns off only
- the ones with ``auto_off_after_drying`` enabled, after their
- per-plug delay. Multiple AMS units finishing close together (e.g. a
- dual-AMS dry that ends within the same MQTT push) call this once
- per unit — the manager's ``_cancel_pending_off`` collapses
- repeated scheduling on the same plug to one timer, so duplicate
- fires are safe.
- """
- try:
- async with async_session() as db:
- await smart_plug_manager.on_drying_complete(printer_id, db)
- except Exception as e:
- logging.getLogger(__name__).warning(
- "Failed to schedule auto-off-after-drying for printer %d (AMS %d): %s",
- printer_id,
- ams_id,
- e,
- )
- printer_manager.set_drying_complete_callback(on_drying_complete)
- async def on_assignment_verified(printer_id: int, ams_id: int, tray_id: int, verified: bool, detail: dict):
- """Surface the read-back result of a spool assignment to the UI (#2582).
- The MQTT client confirms (or fails to confirm) that the tray telemetry
- echoed back the filament id we pushed. We relay that as a websocket
- event so the frontend can toast "loaded" / "assignment didn't take"
- instead of the historic silent fire-and-forget, which made the
- AMS→Studio hand-off feel random to users.
- """
- try:
- from backend.app.services.spool_assignment_notifications import (
- _slot_label_from_global_tray,
- )
- if ams_id == 255:
- global_id = 254 + tray_id
- elif ams_id >= 128:
- global_id = ams_id
- else:
- global_id = ams_id * 4 + tray_id
- slot_label = _slot_label_from_global_tray(global_id)
- printer_info = printer_manager.get_printer(printer_id)
- printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
- await ws_manager.broadcast(
- {
- "type": "spool_assignment_verified",
- "printer_id": printer_id,
- "printer_name": printer_name,
- "ams_id": ams_id,
- "tray_id": tray_id,
- "slot": slot_label,
- "verified": verified,
- # Present on success: False means the filament setting landed
- # but the K-profile (cali_idx) did not — the reporter's exact
- # "loaded but no flow profile" symptom.
- "kprofile_applied": detail.get("kprofile_applied", True),
- # Present on failure: whether any tray telemetry was seen in
- # the window (distinguishes "printer silent" from "printer
- # stored something else").
- "saw_tray": detail.get("saw_tray", False),
- }
- )
- except Exception as e:
- logging.getLogger(__name__).warning(
- "Failed to broadcast assignment verification for printer %d AMS%d-T%d: %s",
- printer_id,
- ams_id,
- tray_id,
- e,
- )
- printer_manager.set_assignment_verified_callback(on_assignment_verified)
- async def on_tray_change(printer_id: int, tray_global: int, layer_num: int):
- """Persist a mid-print tray change for completion-time attribution.
- AMS filament backup switches trays without telling the slicer, so the
- tray-change log is the only record of which spool fed which layers.
- Keeping it only in memory meant a restart mid-print charged everything
- to the tray that finished the job.
- """
- try:
- from backend.app.services.usage_tracker import record_tray_change
- async with async_session() as db:
- await record_tray_change(db, printer_id, tray_global, layer_num)
- except Exception as e:
- logging.getLogger(__name__).warning(
- "Failed to persist tray change for printer %d (tray=%d, layer=%d): %s",
- printer_id,
- tray_global,
- layer_num,
- e,
- )
- printer_manager.set_tray_change_callback(on_tray_change)
- # Initialize MQTT relay from settings
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- mqtt_settings = {
- "mqtt_enabled": (await get_setting(db, "mqtt_enabled") or "false") == "true",
- "mqtt_broker": await get_setting(db, "mqtt_broker") or "",
- "mqtt_port": int(await get_setting(db, "mqtt_port") or "1883"),
- "mqtt_username": await get_setting(db, "mqtt_username") or "",
- "mqtt_password": await get_setting(db, "mqtt_password") or "",
- "mqtt_topic_prefix": await get_setting(db, "mqtt_topic_prefix") or "bambuddy",
- "mqtt_use_tls": (await get_setting(db, "mqtt_use_tls") or "false") == "true",
- }
- await mqtt_relay.configure(mqtt_settings)
- # Restore MQTT smart plug subscriptions
- if mqtt_settings.get("mqtt_enabled"):
- from backend.app.models.smart_plug import SmartPlug
- from backend.app.services.mqtt_smart_plug import subscribe_plug_to_mqtt
- result = await db.execute(select(SmartPlug).where(SmartPlug.plug_type == "mqtt"))
- mqtt_plugs = result.scalars().all()
- restored = 0
- for plug in mqtt_plugs:
- if subscribe_plug_to_mqtt(mqtt_relay.smart_plug_service, plug):
- restored += 1
- if restored:
- logging.info("Restored %s MQTT smart plug subscriptions", restored)
- # Connect to all active printers
- async with async_session() as db:
- await init_printer_connections(db)
- # Auto-connect to Spoolman if enabled
- async with async_session() as db:
- from backend.app.api.routes.settings import get_setting
- spoolman_enabled = await get_setting(db, "spoolman_enabled")
- spoolman_url = await get_setting(db, "spoolman_url")
- if spoolman_enabled and spoolman_enabled.lower() == "true" and spoolman_url:
- try:
- client = await init_spoolman_client(spoolman_url)
- if await client.health_check():
- logging.info("Auto-connected to Spoolman at %s", spoolman_url)
- # Ensure the 'tag' extra field exists for RFID/UUID storage
- field_ok = await client.ensure_tag_extra_field()
- if not field_ok:
- logging.error("Spoolman tag extra field registration failed — NFC tag links may not persist")
- # Register the BambuStudio slicer-preset fields used by the
- # spool-edit / assign flow. Spoolman rejects PATCHes with
- # unknown extra keys, so these must exist before any update
- # that touches them.
- for field_name in ("bambu_slicer_filament", "bambu_slicer_filament_name"):
- if not await client.ensure_extra_field(field_name):
- logging.warning(
- "Spoolman extra field %r registration failed — "
- "spool slicer-preset edits will return 502",
- field_name,
- )
- else:
- logging.warning("Spoolman at %s is not reachable", spoolman_url)
- except Exception as e:
- logging.warning("Failed to auto-connect to Spoolman: %s", e)
- # Start the print scheduler
- spawn_background_task(print_scheduler.run(), name="print-scheduler")
- # Start the smart plug scheduler for time-based on/off
- smart_plug_manager.start_scheduler()
- # Start the Home Assistant sensor poller (#1148)
- ha_sensor_manager.start()
- location_ha_sensor_manager.start()
- # Resume any pending auto-offs that were interrupted by restart
- await smart_plug_manager.resume_pending_auto_offs()
- # Start the notification digest scheduler
- notification_service.start_digest_scheduler()
- # Start the GitHub backup scheduler
- await github_backup_service.start_scheduler()
- # Start the local backup scheduler
- await local_backup_service.start_scheduler()
- await obico_detection_service.start()
- # Start the library trash sweeper (#1008)
- await library_trash_service.start_scheduler()
- # Start the archive auto-purge sweeper (#1008 follow-up)
- await archive_purge_service.start_scheduler()
- # Start AMS history recording
- start_ams_history_recording()
- # Start printer sensor (nozzle / bed / chamber) history recording
- start_printer_sensor_history_recording()
- # Start printer runtime tracking
- start_runtime_tracking()
- # Start SpoolBuddy device watchdog
- start_spoolbuddy_watchdog()
- # Start camera stream orphan cleanup
- start_camera_cleanup()
- # Start the backstop for MQTT sessions paho has stopped recovering (#2732)
- start_connection_watchdog()
- # One-shot sweep for timelapse session directories orphaned by a crash
- # or restart that happened mid-print (in-memory session tracking can't
- # survive that, and nothing else reaps the leftover frames/output file)
- try:
- from backend.app.services.layer_timelapse import cleanup_orphaned_timelapse_sessions
- removed = cleanup_orphaned_timelapse_sessions()
- if removed:
- logging.getLogger(__name__).info("Removed %d orphaned timelapse session artifact(s)", removed)
- except Exception as e:
- logging.getLogger(__name__).warning("Orphaned timelapse session cleanup failed: %s", e)
- # Start expected-print TTL eviction (prevents memory leak when prints are
- # registered but on_print_start never fires)
- start_expected_prints_cleanup()
- # L-2: Start periodic auth cleanup (stale TOTP + expired revoked JTIs)
- start_auth_cleanup()
- from backend.app.services.printer_media import start_printer_download_cleanup
- start_printer_download_cleanup()
- # Event-loop stall watchdog: dumps all thread stacks to stderr if the loop
- # freezes (#1486 — silent "container hangs after adding a printer" reports).
- from backend.app.services.loop_watchdog import start_loop_watchdog
- start_loop_watchdog()
- # Initialize virtual printer manager and sync from DB
- from backend.app.services.virtual_printer import virtual_printer_manager
- virtual_printer_manager.set_session_factory(async_session)
- virtual_printer_manager.set_printer_manager(printer_manager)
- try:
- await virtual_printer_manager.sync_from_db()
- logging.info("Virtual printer manager synced from database")
- except Exception as e:
- logging.warning("Failed to sync virtual printers: %s", e)
- yield
- # Shutdown
- print_scheduler.stop()
- smart_plug_manager.stop_scheduler()
- ha_sensor_manager.stop()
- location_ha_sensor_manager.stop()
- notification_service.stop_digest_scheduler()
- github_backup_service.stop_scheduler()
- local_backup_service.stop_scheduler()
- library_trash_service.stop_scheduler()
- archive_purge_service.stop_scheduler()
- obico_detection_service.stop()
- stop_ams_history_recording()
- stop_printer_sensor_history_recording()
- stop_runtime_tracking()
- stop_spoolbuddy_watchdog()
- stop_camera_cleanup()
- stop_connection_watchdog()
- from backend.app.services.loop_watchdog import stop_loop_watchdog
- stop_loop_watchdog()
- # Tear down all camera fan-out broadcasters (#1089) so subscribers exit
- # cleanly rather than waiting on a queue that nothing will ever fill.
- try:
- from backend.app.services.camera_fanout import shutdown_all_broadcasters
- await shutdown_all_broadcasters()
- except Exception as e:
- logging.warning("Failed to shut down camera broadcasters: %s", e)
- stop_expected_prints_cleanup()
- stop_auth_cleanup()
- from backend.app.services.printer_media import stop_printer_download_cleanup
- await stop_printer_download_cleanup()
- printer_manager.disconnect_all()
- await close_spoolman_client()
- # Stop all virtual printer services
- await virtual_printer_manager.stop_all()
- await mqtt_smart_plug_service.disconnect(timeout=2)
- await mqtt_relay.disconnect(timeout=2)
- # Drop the shared Bambu Cloud HTTP client we registered at startup.
- set_shared_http_client(None)
- set_shared_makerworld_http_client(None)
- set_shared_orca_http_client(None)
- await _shared_cloud_http_client.aclose()
- # Checkpoint WAL (SQLite only) and close all database connections
- from backend.app.core.db_dialect import is_sqlite
- if is_sqlite():
- try:
- async with engine.begin() as conn:
- await conn.execute(text("PRAGMA wal_checkpoint(TRUNCATE)"))
- logging.info("WAL checkpoint completed")
- except Exception as e:
- logging.warning("WAL checkpoint failed: %s", e)
- await engine.dispose()
- app = FastAPI(
- title=app_settings.app_name,
- description="Archive and manage Bambu Lab 3MF files",
- version=APP_VERSION,
- lifespan=lifespan,
- )
- # =============================================================================
- # Authentication Middleware - Secures ALL API routes by default
- # =============================================================================
- # Public routes that don't require authentication even when auth is enabled
- PUBLIC_API_ROUTES = {
- # Auth routes needed before/during login
- "/api/v1/auth/status",
- "/api/v1/auth/login",
- "/api/v1/auth/setup", # Needed for initial setup and recovery
- # Advanced auth status needed for login page
- "/api/v1/auth/advanced-auth/status",
- "/api/v1/auth/forgot-password", # Password reset for advanced auth
- "/api/v1/auth/forgot-password/confirm", # Complete password reset with token (H-6)
- # 2FA routes that are called BEFORE a JWT is issued (pre-auth flow)
- "/api/v1/auth/2fa/verify", # Exchange pre_auth_token + 2FA code for JWT
- "/api/v1/auth/2fa/email/send", # Send OTP email (pre_auth_token based)
- # OIDC routes that must be reachable without a JWT
- "/api/v1/auth/oidc/providers", # Public list of enabled providers
- "/api/v1/auth/oidc/callback", # Redirect target from OIDC provider
- "/api/v1/auth/oidc/exchange", # Exchange short-lived OIDC token for JWT
- # Version check for updates (no sensitive data)
- "/api/v1/updates/version",
- # Metrics endpoint handles its own prometheus_token authentication
- "/api/v1/metrics",
- # Appliance bootstrap (#1589 follow-up): the SPA's i18n setup polls
- # this BEFORE a JWT is available to pick up the firstboot wizard's
- # hostname / timezone / locale and the chrony NTP-gate state. The
- # response contains user-set defaults and a public sync flag — no
- # secrets. Without this entry the global auth middleware returns 401
- # before the route handler runs, regardless of the route's own
- # "no auth required" intent.
- "/api/v1/system/appliance",
- # Cam Wall kiosk feed (#2531): a TV or Pi in kiosk mode has no login, so it
- # authenticates with a long-lived ``camwall``-scoped token in the query
- # string — exactly like the camera streams two lists below, and for the same
- # reason (no header to put a JWT in). "Public" here only means the middleware
- # steps aside; the route still runs RequireCamWallTokenIfAuthEnabled, which
- # rejects an absent, expired, revoked, or wrong-scoped token. In particular a
- # plain ``camera_stream`` token does NOT open this door.
- "/api/v1/camwall/printers",
- }
- # Route prefixes that are public (for routes with dynamic segments)
- PUBLIC_API_PREFIXES = [
- # WebSocket connections handle their own auth
- "/api/v1/ws",
- # OIDC authorize redirects — include provider_id in path
- "/api/v1/auth/oidc/authorize/",
- ]
- # Route patterns that are public (read-only display data)
- # These are checked with "in path" - needed because browsers load images/videos
- # via <img src> and <video src> which don't include Authorization headers
- PUBLIC_API_PATTERNS = [
- # Thumbnails
- "/thumbnail", # /archives/{id}/thumbnail, /library/files/{id}/thumbnail
- "/plate-thumbnail/", # /archives/{id}/plate-thumbnail/{plate_id}
- # Images and media
- "/photos/", # /archives/{id}/photos/{filename}
- "/project-image/", # /archives/{id}/project-image/{path}
- "/qrcode", # /archives/{id}/qrcode
- "/timelapse", # /archives/{id}/timelapse (video)
- "/cover", # /printers/{id}/cover
- "/icon", # /external-links/{id}/icon
- # Camera (streams loaded via <img> tag)
- "/camera/stream", # /printers/{id}/camera/stream
- "/camera/snapshot", # /printers/{id}/camera/snapshot
- # Streaming-overlay status feed (#2613): OBS loads /overlay/{id} with no login
- # and this backs it, authenticated by an ``overlay``-scoped token in the query
- # string (same reasoning as the camera streams above — no header to carry a
- # JWT). "Public" only means the middleware steps aside; the route still runs
- # RequireOverlayTokenIfAuthEnabled, which rejects an absent, expired, revoked,
- # or wrong-scoped token — a camwall or camera_stream token does NOT open it.
- "/overlay-status", # /printers/{id}/overlay-status
- # Slicer token-authenticated downloads — protocol handlers (bambustudioopen://,
- # orcaslicer://) cannot send auth headers. These endpoints validate a short-lived
- # download token in the URL path instead.
- "/dl/", # /archives/{id}/dl/{token}/{filename}, /library/files/{id}/dl/{token}/{filename}
- # Obico ML API fetches JPEG frames by one-shot nonce (issue #172 follow-up).
- # The nonce itself is the credential: 32-byte random, single-use, ~30s TTL.
- "/obico/cached-frame/", # /obico/cached-frame/{nonce}
- ]
- _security_headers_logger = logging.getLogger("backend.app.main.security_headers")
- def _parse_trusted_frame_origins() -> tuple[str, ...]:
- """Parse TRUSTED_FRAME_ORIGINS env var into a validated allowlist (#1191).
- Format: comma-separated list of ``scheme://host[:port]`` origins.
- Used by ``security_headers_middleware`` to relax ``frame-ancestors`` for
- trusted same-LAN deployments (e.g. Home Assistant Webpage panel embedding
- Bambuddy from a different port). Defaults to empty — strict ``'none'``.
- Invalid entries are dropped with a warning rather than failing startup, so
- a typo in one origin doesn't take the whole deployment down.
- """
- raw = os.environ.get("TRUSTED_FRAME_ORIGINS", "").strip()
- if not raw:
- return ()
- valid: list[str] = []
- for item in raw.split(","):
- candidate = item.strip()
- if not candidate:
- continue
- try:
- parsed = urlparse(candidate)
- except ValueError as e:
- _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — %s", candidate, e)
- continue
- if parsed.scheme not in ("http", "https"):
- _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — must be http(s)", candidate)
- continue
- if not parsed.netloc:
- _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — missing host", candidate)
- continue
- if parsed.path and parsed.path != "/":
- _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — paths not allowed", candidate)
- continue
- if parsed.query or parsed.fragment:
- _security_headers_logger.warning(
- "TRUSTED_FRAME_ORIGINS: dropping %r — query/fragment not allowed", candidate
- )
- continue
- if "*" in parsed.netloc:
- _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — wildcards not allowed", candidate)
- continue
- valid.append(f"{parsed.scheme}://{parsed.netloc}")
- if valid:
- _security_headers_logger.info("TRUSTED_FRAME_ORIGINS: %s", ", ".join(valid))
- return tuple(valid)
- _TRUSTED_FRAME_ORIGINS: tuple[str, ...] = _parse_trusted_frame_origins()
- def _frame_ancestors(default_value: str) -> str:
- """Compose the ``frame-ancestors`` CSP directive (#1191).
- ``default_value`` is the strict directive used when the operator has not
- configured ``TRUSTED_FRAME_ORIGINS`` — typically ``'none'`` (catch-all and
- docs) or ``'self'`` (the streaming overlay, embedded same-origin by the
- Settings URL builder's preview). When trusted origins
- are configured, ``'self'`` is always included so same-origin embedding never
- breaks even if an operator forgets to add their own origin to the list.
- """
- if _TRUSTED_FRAME_ORIGINS:
- return "frame-ancestors 'self' " + " ".join(_TRUSTED_FRAME_ORIGINS) + ";"
- return f"frame-ancestors {default_value};"
- @app.middleware("http")
- async def security_headers_middleware(request, call_next):
- """Add standard HTTP security headers to every response."""
- # Per-request nonce stamped into `script-src` (#1460). On its own this
- # changes nothing for Bambuddy's own pages — index.html has no inline
- # scripts since the SW registration moved to /sw-register.js. The reason
- # it's here is Cloudflare: a CF-fronted deployment has the bot-detection
- # script injected into the HTML on the edge, with a fresh hash on every
- # load (so hashes can't be allowlisted). When CF sees a nonce in our CSP,
- # it clones the same nonce onto its injected <script>, and the inline
- # script passes the policy without us needing 'unsafe-inline'. See
- # https://developers.cloudflare.com/cloudflare-challenges/challenge-types/javascript-detections/#if-you-have-a-content-security-policy-csp
- csp_nonce = secrets.token_urlsafe(16)
- response = await call_next(request)
- response.headers["X-Content-Type-Options"] = "nosniff"
- # X-Frame-Options is the legacy cross-origin embedding control. Modern
- # browsers honour CSP frame-ancestors instead, and the legacy
- # `ALLOW-FROM <url>` syntax is deprecated and inconsistent across vendors.
- # When operators have explicitly allowlisted trusted frame origins (#1191
- # — typically Home Assistant on a different port), drop X-Frame-Options
- # and let the CSP-side frame-ancestors directive govern embedding.
- if not _TRUSTED_FRAME_ORIGINS:
- response.headers["X-Frame-Options"] = "SAMEORIGIN"
- response.headers["Referrer-Policy"] = "strict-origin-when-cross-origin"
- # Content-Security-Policy for the React SPA.
- # Notes:
- # - 'unsafe-inline' for style-src: React and UI libs inject inline styles at runtime.
- # - connect-src ws:/wss:: MQTT/printer WebSocket connections.
- # - img-src data: / blob:: base64 thumbnails and Blob-URL timelapse previews.
- # - media-src blob:: timelapse video player uses Blob URLs.
- # - font-src data:: some icon fonts are embedded as data URIs.
- if request.url.path in ("/docs", "/redoc", "/docs/oauth2-redirect"):
- # FastAPI's built-in Swagger UI / ReDoc pages load assets from
- # cdn.jsdelivr.net and bootstrap with an inline <script>, so the
- # default CSP would render a blank page.
- response.headers["Content-Security-Policy"] = (
- "default-src 'self'; "
- "script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; "
- "style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net https://fonts.googleapis.com; "
- "img-src 'self' data: blob: https://fastapi.tiangolo.com https://cdn.redoc.ly; "
- "connect-src 'self'; "
- "font-src 'self' data: https://fonts.gstatic.com; "
- "worker-src 'self' blob:; "
- "object-src 'none'; "
- "base-uri 'self'; " + _frame_ancestors("'none'")
- )
- else:
- # The streaming overlay is embedded same-origin by the URL builder's
- # preview in Settings (#1422), so this branch allows 'self'.
- # Embedding from anywhere else is still refused: 'self'
- # only permits a framer on this origin, which is Bambuddy's own UI, so
- # a clickjacking page on another host is blocked exactly as before.
- # (The overlay draws status over a camera feed and its only interactive
- # element is the logo link, so there is nothing to bait a click into
- # even from a same-origin framer.) Cross-origin embedding of the
- # overlay — Home Assistant on another port — remains what
- # TRUSTED_FRAME_ORIGINS is for, and _frame_ancestors already folds that
- # allowlist in.
- embeddable_same_origin = request.url.path.startswith("/overlay/")
- response.headers["Content-Security-Policy"] = (
- "default-src 'self'; "
- f"script-src 'self' 'nonce-{csp_nonce}'; "
- "style-src 'self' 'unsafe-inline'; "
- "img-src 'self' data: blob:; "
- "media-src 'self' blob:; "
- "connect-src 'self' ws: wss:; "
- "font-src 'self' data:; "
- "object-src 'none'; "
- "base-uri 'self'; "
- "frame-src 'self' http: https:; " + _frame_ancestors("'self'" if embeddable_same_origin else "'none'")
- )
- if request.url.scheme == "https":
- response.headers["Strict-Transport-Security"] = "max-age=31536000; includeSubDomains"
- return response
- @app.middleware("http")
- async def auth_middleware(request, call_next):
- """Enforce authentication on all API routes when auth is enabled.
- This middleware provides defense-in-depth by checking auth at the API gateway level,
- regardless of whether individual routes have auth dependencies.
- """
- from starlette.responses import JSONResponse
- path = request.url.path
- # Only apply to API routes
- if not path.startswith("/api/"):
- return await call_next(request)
- # Allow public routes
- if path in PUBLIC_API_ROUTES:
- return await call_next(request)
- # Allow public prefixes
- for prefix in PUBLIC_API_PREFIXES:
- if path.startswith(prefix):
- return await call_next(request)
- # Allow public patterns (read-only display data like thumbnails)
- for pattern in PUBLIC_API_PATTERNS:
- if pattern in path:
- return await call_next(request)
- # Check if auth is enabled. Fail CLOSED on any exception during the
- # probe — GHSA-6mf4-q26m-47pv: the previous fail-open path here let
- # an attacker who could force a DB exception (e.g. file-descriptor
- # exhaustion via login flood) bypass auth on every protected endpoint.
- try:
- async with async_session() as db:
- from backend.app.core.auth import is_auth_enabled
- auth_enabled = await is_auth_enabled(db)
- if not auth_enabled:
- # Auth disabled, allow all requests
- return await call_next(request)
- except Exception:
- logging.getLogger(__name__).exception("auth_middleware: failing closed on auth-probe error from %s", path)
- return JSONResponse(
- status_code=503,
- content={"detail": "Authentication service temporarily unavailable"},
- )
- # Auth is enabled - require valid token
- auth_header = request.headers.get("Authorization")
- x_api_key = request.headers.get("X-API-Key")
- # Check for API key auth first
- if x_api_key or (auth_header and auth_header.startswith("Bearer bb_")):
- # API key authentication - let the request through to be validated by route handler
- # API keys are validated per-route since they have different permission levels
- return await call_next(request)
- # Check for JWT auth
- if not auth_header or not auth_header.startswith("Bearer "):
- return JSONResponse(
- status_code=401,
- content={"detail": "Authentication required"},
- headers={"WWW-Authenticate": "Bearer"},
- )
- # Validate JWT token
- import jwt
- try:
- from backend.app.core.auth import (
- ALGORITHM,
- SECRET_KEY,
- _is_token_fresh,
- get_user_by_username,
- is_jti_revoked,
- )
- token = auth_header.replace("Bearer ", "")
- payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
- username = payload.get("sub")
- if not username:
- raise ValueError("No username in token")
- jti = payload.get("jti")
- if not jti:
- raise ValueError("No jti in token")
- iat = payload.get("iat")
- # Verify user exists, is active, and token is still fresh (L-R8-A).
- # Reject revoked tokens first (defense-in-depth gateway check), reusing
- # this session so the gateway adds a single pooled checkout, not two (#2572).
- async with async_session() as db:
- if await is_jti_revoked(jti, db):
- return JSONResponse(
- status_code=401,
- content={"detail": "Token has been revoked"},
- headers={"WWW-Authenticate": "Bearer"},
- )
- user = await get_user_by_username(db, username)
- if not user or not user.is_active:
- return JSONResponse(
- status_code=401,
- content={"detail": "User not found or inactive"},
- headers={"WWW-Authenticate": "Bearer"},
- )
- if not _is_token_fresh(iat, user):
- return JSONResponse(
- status_code=401,
- content={"detail": "Token no longer valid"},
- headers={"WWW-Authenticate": "Bearer"},
- )
- except jwt.ExpiredSignatureError:
- return JSONResponse(
- status_code=401,
- content={"detail": "Token has expired"},
- headers={"WWW-Authenticate": "Bearer"},
- )
- except (jwt.InvalidTokenError, ValueError, Exception):
- return JSONResponse(
- status_code=401,
- content={"detail": "Invalid token"},
- headers={"WWW-Authenticate": "Bearer"},
- )
- return await call_next(request)
- @app.middleware("http")
- async def trace_id_middleware(request, call_next):
- """Stamp every HTTP request with a trace ID and echo it back.
- Decorated AFTER auth_middleware on purpose: Starlette stacks
- @app.middleware decorators LIFO, so the last-decorated runs first
- inbound. Putting the trace stamp last makes it the OUTERMOST layer,
- which means auth-middleware log lines (and every line emitted on the
- way down to and back from the route handler) all carry the same
- trace ID. If we put it before auth, auth's logs would be stamped
- with the *previous* request's ID — useless for correlation.
- Honours an inbound ``X-Trace-Id`` header so callers running their
- own tracing can correlate their span IDs with our log lines, but
- only if the value passes the whitelist gate in
- ``backend.app.core.trace.normalise_inbound_trace_id`` — anything
- rejected (too long, contains control chars, etc.) silently triggers
- a freshly minted server-side ID rather than failing the request.
- The minted (or echoed) ID is set on a ContextVar so that every log
- record emitted during the request — application logs *and* uvicorn's
- access log — carries it via TraceIDFilter, and is also written to
- the ``X-Trace-Id`` response header so clients can pin a server-side
- log search to the exact request they made.
- """
- from backend.app.core.trace import (
- generate_trace_id,
- normalise_inbound_trace_id,
- trace_id_var,
- )
- inbound = normalise_inbound_trace_id(request.headers.get("X-Trace-Id"))
- trace_id = inbound if inbound is not None else generate_trace_id()
- token = trace_id_var.set(trace_id)
- try:
- response = await call_next(request)
- finally:
- # Reset the ContextVar so a record emitted in a totally
- # unrelated background task that just happens to inherit this
- # context doesn't keep referencing this request's ID forever.
- # In practice ContextVar.reset is best-effort under asyncio
- # task-spawn semantics, but the cost is one attribute write so
- # we may as well do it.
- trace_id_var.reset(token)
- response.headers["X-Trace-Id"] = trace_id
- return response
- # API routes
- app.include_router(auth.router, prefix=app_settings.api_prefix)
- app.include_router(mfa.router, prefix=app_settings.api_prefix)
- app.include_router(bug_report.router, prefix=app_settings.api_prefix)
- app.include_router(users.router, prefix=app_settings.api_prefix)
- app.include_router(groups.router, prefix=app_settings.api_prefix)
- app.include_router(printers.router, prefix=app_settings.api_prefix)
- app.include_router(archives.router, prefix=app_settings.api_prefix)
- app.include_router(filaments.router, prefix=app_settings.api_prefix)
- app.include_router(finance.router, prefix=app_settings.api_prefix)
- app.include_router(inventory.router, prefix=app_settings.api_prefix)
- app.include_router(labels.router, prefix=app_settings.api_prefix)
- app.include_router(settings_routes.router, prefix=app_settings.api_prefix)
- app.include_router(cloud.router, prefix=app_settings.api_prefix)
- app.include_router(orca_cloud.router, prefix=app_settings.api_prefix)
- app.include_router(local_presets.router, prefix=app_settings.api_prefix)
- app.include_router(smart_plugs.router, prefix=app_settings.api_prefix)
- app.include_router(ha_sensors.router, prefix=app_settings.api_prefix)
- app.include_router(location_ha_sensors.router, prefix=app_settings.api_prefix)
- app.include_router(print_log.router, prefix=app_settings.api_prefix)
- app.include_router(print_queue.router, prefix=app_settings.api_prefix)
- app.include_router(scheduled_dryings.router, prefix=app_settings.api_prefix)
- app.include_router(kprofiles.router, prefix=app_settings.api_prefix)
- app.include_router(notifications.router, prefix=app_settings.api_prefix)
- app.include_router(notification_templates.router, prefix=app_settings.api_prefix)
- app.include_router(user_notifications.router, prefix=app_settings.api_prefix)
- app.include_router(spoolman.router, prefix=app_settings.api_prefix)
- app.include_router(spoolman_inventory.router, prefix=app_settings.api_prefix)
- app.include_router(updates.router, prefix=app_settings.api_prefix)
- app.include_router(sponsor_prompt.router, prefix=app_settings.api_prefix)
- app.include_router(maintenance.router, prefix=app_settings.api_prefix)
- app.include_router(camera.router, prefix=app_settings.api_prefix)
- app.include_router(camwall.router, prefix=app_settings.api_prefix)
- app.include_router(external_links.router, prefix=app_settings.api_prefix)
- app.include_router(projects.router, prefix=app_settings.api_prefix)
- app.include_router(library.router, prefix=app_settings.api_prefix)
- app.include_router(library_tags.router, prefix=app_settings.api_prefix)
- app.include_router(library_trash.router, prefix=app_settings.api_prefix)
- app.include_router(library_variants.router, prefix=app_settings.api_prefix)
- app.include_router(slice_jobs.router, prefix=app_settings.api_prefix)
- app.include_router(slicer_pipelines.router, prefix=app_settings.api_prefix)
- app.include_router(pipeline_runs.pipeline_run_create_router, prefix=app_settings.api_prefix)
- app.include_router(pipeline_runs.pipeline_run_router, prefix=app_settings.api_prefix)
- app.include_router(slicer_presets.router, prefix=app_settings.api_prefix)
- app.include_router(archive_purge.router, prefix=app_settings.api_prefix)
- app.include_router(makerworld.router, prefix=app_settings.api_prefix)
- app.include_router(api_keys.router, prefix=app_settings.api_prefix)
- app.include_router(webhook.router, prefix=app_settings.api_prefix)
- app.include_router(ams_history.router, prefix=app_settings.api_prefix)
- app.include_router(printer_sensor_history.router, prefix=app_settings.api_prefix)
- app.include_router(system.router, prefix=app_settings.api_prefix)
- app.include_router(support.router, prefix=app_settings.api_prefix)
- app.include_router(websocket.router, prefix=app_settings.api_prefix)
- app.include_router(discovery.router, prefix=app_settings.api_prefix)
- app.include_router(pending_uploads.router, prefix=app_settings.api_prefix)
- app.include_router(firmware.router, prefix=app_settings.api_prefix)
- app.include_router(github_backup.router, prefix=app_settings.api_prefix)
- app.include_router(local_backup.router, prefix=app_settings.api_prefix)
- app.include_router(obico.router, prefix=app_settings.api_prefix)
- app.include_router(metrics.router, prefix=app_settings.api_prefix)
- app.include_router(virtual_printers.router, prefix=app_settings.api_prefix)
- app.include_router(spoolbuddy.router, prefix=app_settings.api_prefix)
- # Serve static files (React build)
- if app_settings.static_dir.exists() and any(app_settings.static_dir.iterdir()):
- app.mount(
- "/assets",
- StaticFiles(directory=app_settings.static_dir / "assets"),
- name="assets",
- )
- if (app_settings.static_dir / "img").exists():
- app.mount(
- "/img",
- StaticFiles(directory=app_settings.static_dir / "img"),
- name="img",
- )
- if (app_settings.static_dir / "icons").exists():
- app.mount(
- "/icons",
- StaticFiles(directory=app_settings.static_dir / "icons"),
- name="icons",
- )
- # Self-hosted Inter woff2 files (#1460). Without this mount /fonts/*.woff2
- # falls through to the SPA catch-all and returns index.html, which the
- # browser's font sanitizer rejects ("downloadable font: rejected by
- # sanitizer").
- if (app_settings.static_dir / "fonts").exists():
- app.mount(
- "/fonts",
- StaticFiles(directory=app_settings.static_dir / "fonts"),
- name="fonts",
- )
- @app.get("/")
- async def serve_frontend():
- """Serve the React frontend."""
- index_file = app_settings.static_dir / "index.html"
- if index_file.exists():
- return FileResponse(index_file, headers=_HTML_CACHE_HEADERS)
- return {
- "message": "Bambuddy API",
- "docs": "/docs",
- "frontend": "Build and place React app in /static directory",
- }
- # index.html must always be revalidated — Vite emits content-hashed JS/CSS
- # bundles (e.g. `index-JRaF_JhW.js`), so the JS itself is safe to cache
- # forever, but the HTML wrapping it is the only file that knows which hash
- # is current. Without explicit cache-control headers Chromium decides
- # heuristically (typically 10% of the time since Last-Modified) and on
- # long-running kiosks happily serves stale HTML across browser restarts.
- # That stale HTML references an old bundle hash, the old bundle is also
- # in the disk cache, and the user ends up running pre-update JS forever
- # without ever knowing why. ``no-cache`` (revalidate every time, but a
- # 304 is cheap) is the correct setting for an SPA's entry HTML.
- _HTML_CACHE_HEADERS = {"Cache-Control": "no-cache, must-revalidate"}
- @app.get("/health")
- async def health_check():
- """Health check endpoint."""
- return {"status": "healthy"}
- # GET + HEAD on the three PWA bootstrap routes (#1460). Scanners and a plain
- # `curl -I` use HEAD; FastAPI's @app.get only registers GET, so HEAD answers
- # with 405 Method Not Allowed and shows up as a "broken manifest" red herring
- # in deployment debugging.
- @app.api_route("/manifest.json", methods=["GET", "HEAD"])
- async def serve_manifest():
- """Serve PWA manifest."""
- manifest_file = app_settings.static_dir / "manifest.json"
- if manifest_file.exists():
- return FileResponse(manifest_file, media_type="application/manifest+json")
- return {"error": "Manifest not found"}
- @app.api_route("/sw.js", methods=["GET", "HEAD"])
- async def serve_service_worker():
- """Serve service worker."""
- sw_file = app_settings.static_dir / "sw.js"
- if sw_file.exists():
- return FileResponse(
- sw_file,
- media_type="application/javascript",
- headers={"Cache-Control": "no-cache, no-store, must-revalidate"},
- )
- return {"error": "Service worker not found"}
- @app.api_route("/sw-register.js", methods=["GET", "HEAD"])
- async def serve_sw_register():
- """Serve the service-worker registration bootstrap script.
- Served as a real JS file so the strict `script-src 'self'` CSP covers it
- without needing 'unsafe-inline' or per-build hashes on the inline tag.
- """
- reg_file = app_settings.static_dir / "sw-register.js"
- if reg_file.exists():
- return FileResponse(reg_file, media_type="application/javascript")
- return {"error": "sw-register.js not found"}
- # ── GCode viewer static files ────────────────────────────────────────────────
- # Catch-all route for React Router (must be last)
- @app.get("/{full_path:path}")
- async def serve_spa(full_path: str):
- """Serve React app for client-side routing."""
- # Don't intercept API routes - raise proper 404 so FastAPI can handle redirects
- if full_path.startswith("api/"):
- from fastapi import HTTPException
- raise HTTPException(status_code=404, detail="Not found")
- index_file = app_settings.static_dir / "index.html"
- if index_file.exists():
- return FileResponse(index_file, headers=_HTML_CACHE_HEADERS)
- return {"error": "Frontend not built"}
|