main.py 520 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753
  1. import asyncio
  2. import json
  3. import logging
  4. import math
  5. import os
  6. import posixpath
  7. import re
  8. import secrets
  9. import time
  10. from contextlib import asynccontextmanager
  11. from datetime import datetime, timedelta, timezone
  12. from logging.handlers import RotatingFileHandler
  13. from pathlib import Path, PurePosixPath
  14. from urllib.parse import urlparse
  15. from fastapi import FastAPI
  16. from fastapi.responses import FileResponse
  17. from fastapi.staticfiles import StaticFiles
  18. from sqlalchemy import delete, or_, select, text
  19. from backend.app.api.routes import (
  20. ams_history,
  21. announcements,
  22. api_keys,
  23. archive_purge,
  24. archives,
  25. auth,
  26. bug_report,
  27. camera,
  28. camwall,
  29. cloud,
  30. connected_apps,
  31. discovery,
  32. external_links,
  33. filaments,
  34. finance,
  35. firmware,
  36. github_backup,
  37. groups,
  38. ha_sensors,
  39. inventory,
  40. kprofiles,
  41. labels,
  42. library,
  43. library_tags,
  44. library_trash,
  45. library_variants,
  46. local_backup,
  47. local_presets,
  48. location_ha_sensors,
  49. maintenance,
  50. makerworld,
  51. metrics,
  52. mfa,
  53. notification_templates,
  54. notifications,
  55. obico,
  56. orca_cloud,
  57. pending_uploads,
  58. pipeline_runs,
  59. print_log,
  60. print_queue,
  61. printer_sensor_history,
  62. printers,
  63. projects,
  64. scheduled_dryings,
  65. settings as settings_routes,
  66. slice_jobs,
  67. slicer_pipelines,
  68. slicer_presets,
  69. smart_plugs,
  70. sponsor_prompt,
  71. spoolbuddy,
  72. spoolman,
  73. spoolman_inventory,
  74. support,
  75. system,
  76. updates,
  77. user_notifications,
  78. users,
  79. virtual_printers,
  80. webhook,
  81. websocket,
  82. )
  83. from backend.app.api.routes.maintenance import _get_printer_maintenance_internal, ensure_default_types
  84. from backend.app.api.routes.support import init_debug_logging
  85. from backend.app.core.config import APP_VERSION, settings as app_settings
  86. from backend.app.core.database import async_session, engine, init_db
  87. from backend.app.core.tasks import spawn_background_task
  88. from backend.app.core.websocket import ws_manager
  89. from backend.app.services import print_dispatch_context, slot_unlink_grace
  90. from backend.app.services.archive import ArchiveService, peek_plate_index_in_3mf, swap_plate_suffix
  91. from backend.app.services.archive_purge import archive_purge_service
  92. from backend.app.services.bambu_ftp import (
  93. FileNotOnPrinterError,
  94. cache_3mf_download,
  95. clear_3mf_cache,
  96. download_file_async,
  97. download_file_try_paths_async,
  98. ftps_handshake_blocked,
  99. get_cached_3mf,
  100. get_ftp_retry_settings,
  101. normalize_3mf_name,
  102. with_ftp_retry,
  103. )
  104. from backend.app.services.bambu_mqtt import PrinterState
  105. from backend.app.services.energy_plug import energy_plug_candidates, select_energy_reading
  106. from backend.app.services.github_backup import github_backup_service
  107. from backend.app.services.ha_sensor_manager import ha_sensor_manager
  108. from backend.app.services.homeassistant import homeassistant_service
  109. from backend.app.services.library_trash import library_trash_service
  110. from backend.app.services.local_backup import local_backup_service
  111. from backend.app.services.location_ha_sensor_manager import location_ha_sensor_manager
  112. from backend.app.services.mqtt_relay import mqtt_relay
  113. from backend.app.services.mqtt_smart_plug import mqtt_smart_plug_service
  114. from backend.app.services.notification_service import notification_service
  115. from backend.app.services.obico_detection import obico_detection_service
  116. from backend.app.services.print_cost_estimate import plate_scoped_run_estimate as _plate_scoped_run_estimate
  117. from backend.app.services.print_scheduler import scheduler as print_scheduler
  118. from backend.app.services.print_storage import (
  119. REASON_FTP_TRANSFER_FAILED,
  120. REASON_FTPS_COOLOFF,
  121. external_storage_present,
  122. ftp_probe_paths,
  123. print_file_reachable_over_ftp,
  124. )
  125. from backend.app.services.printer_manager import (
  126. init_printer_connections,
  127. parse_plate_id,
  128. printer_manager,
  129. printer_state_to_dict,
  130. resolve_plate_id,
  131. )
  132. from backend.app.services.slot_kprofile import find_slot_kprofile_for_extruder
  133. from backend.app.services.slot_nozzle import (
  134. nozzle_diameter_for_extruder,
  135. nozzle_flow_for_extruder,
  136. resolve_slot_nozzle,
  137. )
  138. from backend.app.services.smart_plug_manager import smart_plug_manager
  139. from backend.app.services.spool_assignment_notifications import (
  140. notify_missing_spool_assignments_on_print_start,
  141. )
  142. from backend.app.services.spool_filament_preset import printer_safe_filament_id
  143. from backend.app.services.spoolman import close_spoolman_client, get_spoolman_client, init_spoolman_client
  144. from backend.app.services.spoolman_tracking import (
  145. cleanup_tracking as _cleanup_spoolman_tracking,
  146. report_usage as _report_spoolman_usage,
  147. store_print_data as _store_spoolman_print_data,
  148. )
  149. from backend.app.services.tasmota import tasmota_service
  150. from backend.app.services.telegram_reactions import telegram_reaction_poller
  151. from backend.app.utils.ams_drying import is_drying_active, temperature_alarm_suppressed
  152. from backend.app.utils.ams_humidity import ams_humidity_percent
  153. from backend.app.utils.filament_types import printer_filament_type
  154. from backend.app.utils.fts_routing import extruder_for_inlet
  155. from backend.app.utils.local_time import utcnow_naive
  156. from backend.app.utils.print_jobs import is_internal_printer_job
  157. # =============================================================================
  158. # Dependency Check - runs before other imports to give helpful error messages
  159. # =============================================================================
  160. def _start_error_server(missing_packages: list):
  161. """Start a minimal HTTP server to display dependency errors in browser."""
  162. import os
  163. import signal
  164. from http.server import BaseHTTPRequestHandler, HTTPServer
  165. packages_html = "".join(f"<li><code>{p}</code></li>" for p in missing_packages)
  166. html = f"""<!DOCTYPE html>
  167. <html>
  168. <head>
  169. <title>Bambuddy - Setup Required</title>
  170. <style>
  171. body {{
  172. font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
  173. background: #0f172a; color: #e2e8f0;
  174. display: flex; justify-content: center; align-items: center;
  175. min-height: 100vh; margin: 0; padding: 20px; box-sizing: border-box;
  176. }}
  177. .container {{
  178. background: #1e293b; border-radius: 12px; padding: 40px;
  179. max-width: 600px; text-align: center; box-shadow: 0 4px 20px rgba(0,0,0,0.3);
  180. }}
  181. h1 {{ color: #f87171; margin-bottom: 10px; }}
  182. h2 {{ color: #94a3b8; font-weight: normal; margin-top: 0; }}
  183. .packages {{
  184. background: #0f172a; border-radius: 8px; padding: 20px;
  185. margin: 20px 0; text-align: left;
  186. }}
  187. .packages ul {{ margin: 0; padding-left: 20px; }}
  188. .packages li {{ color: #fbbf24; margin: 8px 0; }}
  189. .command {{
  190. background: #0f172a; border-radius: 8px; padding: 15px 20px;
  191. margin: 15px 0; font-family: monospace; color: #4ade80;
  192. text-align: left; overflow-x: auto;
  193. }}
  194. .note {{ color: #94a3b8; font-size: 14px; margin-top: 20px; }}
  195. </style>
  196. </head>
  197. <body>
  198. <div class="container">
  199. <h1>Setup Required</h1>
  200. <h2>Missing Python packages</h2>
  201. <div class="packages"><ul>{packages_html}</ul></div>
  202. <p>To fix, run this command on your server:</p>
  203. <div class="command">pip install -r requirements.txt</div>
  204. <p>Or if using a virtual environment:</p>
  205. <div class="command">./venv/bin/pip install -r requirements.txt</div>
  206. <p class="note">After installing, restart Bambuddy:<br>
  207. <code>sudo systemctl restart bambuddy</code></p>
  208. </div>
  209. </body>
  210. </html>"""
  211. class ErrorHandler(BaseHTTPRequestHandler):
  212. def do_GET(self):
  213. self.send_response(503)
  214. self.send_header("Content-type", "text/html")
  215. self.end_headers()
  216. self.wfile.write(html.encode())
  217. def log_message(self, format, *args):
  218. print(f"[Error Server] {args[0]}")
  219. port = int(os.environ.get("PORT", 8000))
  220. print(f"\nStarting error server on http://0.0.0.0:{port}")
  221. print("Visit this URL in your browser to see the error details.\n")
  222. server = HTTPServer(("0.0.0.0", port), ErrorHandler) # nosec B104
  223. def shutdown(signum, frame):
  224. print("\nShutting down error server...")
  225. raise SystemExit(0)
  226. signal.signal(signal.SIGTERM, shutdown)
  227. signal.signal(signal.SIGINT, shutdown)
  228. server.serve_forever()
  229. def check_dependencies():
  230. """Check that all required packages are installed."""
  231. missing = []
  232. # Map of import name -> package name (for pip install)
  233. required = {
  234. "jwt": "PyJWT",
  235. "fastapi": "fastapi",
  236. "uvicorn": "uvicorn",
  237. "sqlalchemy": "sqlalchemy",
  238. "aiosqlite": "aiosqlite",
  239. "pydantic": "pydantic",
  240. "paho.mqtt": "paho-mqtt",
  241. }
  242. for module, package in required.items():
  243. try:
  244. __import__(module)
  245. except ImportError:
  246. missing.append(package)
  247. if missing:
  248. print("\n" + "=" * 60)
  249. print("ERROR: Missing required Python packages!")
  250. print("=" * 60)
  251. print(f"\nMissing packages: {', '.join(missing)}")
  252. print("\nTo fix, run:")
  253. print(" pip install -r requirements.txt")
  254. print("\nOr if using a virtual environment:")
  255. print(" ./venv/bin/pip install -r requirements.txt")
  256. print("=" * 60 + "\n")
  257. _start_error_server(missing)
  258. check_dependencies()
  259. # =============================================================================
  260. # Import settings first for logging configuration
  261. # Configure logging based on settings
  262. # DEBUG=true -> DEBUG level, else use LOG_LEVEL setting
  263. log_level_str = "DEBUG" if app_settings.debug else app_settings.log_level.upper()
  264. log_level = getattr(logging, log_level_str, logging.INFO)
  265. # Trace ID column ([-] when no request scope is active — startup, MQTT
  266. # callbacks, scheduled tasks not chained from a request — so the column
  267. # stays visually aligned and missing values are obvious in grep). See
  268. # backend/app/core/trace.py for the ContextVar that feeds this slot.
  269. log_format = "%(asctime)s %(levelname)s [%(name)s] [%(trace_id)s] %(message)s"
  270. # Create root logger
  271. root_logger = logging.getLogger()
  272. root_logger.setLevel(log_level)
  273. # Trace-ID injection: this filter populates record.trace_id from the
  274. # per-request ContextVar so the format string above can reference it.
  275. # Attached to each HANDLER (not the root logger) because Python's
  276. # logging semantics only invoke a logger's filters on records that
  277. # *originated* at that logger — records propagated up from child
  278. # loggers (every named logger in the app) never trigger root's filter.
  279. # Putting it on the handlers means every record any handler emits gets
  280. # trace_id injected just before the formatter runs, regardless of which
  281. # logger created the record. Without this, the formatter raises
  282. # KeyError on every child-logger record and the record is silently
  283. # dropped — which is exactly the "logs/bambuddy.log only shows logs
  284. # partially" bug we hit. See backend/app/core/trace.py for the
  285. # ContextVar the filter reads.
  286. from backend.app.core.trace import TraceIDFilter
  287. _trace_id_filter = TraceIDFilter()
  288. # Console handler - always enabled
  289. console_handler = logging.StreamHandler()
  290. console_handler.setLevel(log_level)
  291. console_handler.setFormatter(logging.Formatter(log_format))
  292. console_handler.addFilter(_trace_id_filter)
  293. root_logger.addHandler(console_handler)
  294. # File handler - only in production or if explicitly enabled
  295. if app_settings.log_to_file:
  296. log_file = app_settings.log_dir / "bambuddy.log"
  297. file_handler = RotatingFileHandler(
  298. log_file,
  299. maxBytes=app_settings.log_max_bytes,
  300. backupCount=app_settings.log_backup_count,
  301. encoding="utf-8",
  302. )
  303. file_handler.setLevel(log_level)
  304. file_handler.setFormatter(logging.Formatter(log_format))
  305. file_handler.addFilter(_trace_id_filter)
  306. root_logger.addHandler(file_handler)
  307. logging.info("Logging to file: %s", log_file)
  308. # Pipe uvicorn's HTTP access log to bambuddy.log too. Uvicorn ships its
  309. # access logger with propagate=False by default, so without this attach
  310. # there is no on-disk record of which endpoint triggered a server-state
  311. # change — the rogue stop_print mystery on 2026-04-26 was untraceable
  312. # for exactly this reason. Filtered to write methods only
  313. # (POST/PUT/PATCH/DELETE) so the high-volume status-poll GETs from the
  314. # frontend don't churn the rotation window faster than it's useful.
  315. from backend.app.core.logging_filters import (
  316. CancelledPoolNoiseFilter,
  317. WriteRequestsOnlyFilter,
  318. )
  319. uvicorn_access_logger = logging.getLogger("uvicorn.access")
  320. uvicorn_access_logger.addHandler(file_handler)
  321. uvicorn_access_logger.addFilter(WriteRequestsOnlyFilter())
  322. # Uvicorn's access logger has propagate=False (its own default), so the
  323. # root-attached TraceIDFilter never sees these records. Attach a
  324. # second instance directly so HTTP access lines carry the same trace
  325. # ID column as the application logs they correlate with.
  326. uvicorn_access_logger.addFilter(TraceIDFilter())
  327. # Drop SQLAlchemy connection-pool log noise that's caused by Starlette's
  328. # BaseHTTPMiddleware cancelling the inner task scope on client
  329. # disconnect (#1112). The cancel-safe `get_db` already prevents the
  330. # underlying transaction leak; this filter only suppresses the residual
  331. # log records that pre-existing pools still emit during their cleanup.
  332. logging.getLogger("sqlalchemy.pool").addFilter(CancelledPoolNoiseFilter())
  333. # Reduce noise from third-party libraries in production
  334. if not app_settings.debug:
  335. logging.getLogger("sqlalchemy.engine").setLevel(logging.WARNING)
  336. logging.getLogger("httpcore").setLevel(logging.WARNING)
  337. logging.getLogger("httpx").setLevel(logging.WARNING)
  338. logging.getLogger("paho.mqtt").setLevel(logging.WARNING)
  339. logging.info("Bambuddy starting - debug=%s, log_level=%s", app_settings.debug, log_level_str)
  340. # Track active prints: {(printer_id, filename): archive_id}
  341. _active_prints: dict[tuple[int, str], int] = {}
  342. # #1721: stage-22 pre-captured finish photo bytes per printer. on_finish_photo_moment
  343. # fires when stg_cur enters 22 ("Filament unloading") at end-of-print — toolhead
  344. # parked, bed not yet dropped — and grabs a single camera frame into this cache.
  345. # `_background_finish_photo` (inside on_print_complete) consumes the cached bytes
  346. # instead of running its own grab-now chain when present, so the finish photo
  347. # captures the better-framed pre-bed-drop moment without us having to force
  348. # timelapse on at dispatch (the #1397 mechanism that caused #1721's per-layer
  349. # nozzle parking on slicer profiles with Timelapse Type = Smooth).
  350. #
  351. # #2708: the bytes in here are ALWAYS already rotated by the printer's
  352. # camera_rotation. `on_finish_photo_moment` owns that, because one of its
  353. # sources (the #1867 in-print bank) is rotated before it ever reaches the
  354. # bank and the others are not — so the consumer can't tell them apart and
  355. # must not rotate again.
  356. _stage22_finish_frames: dict[int, bytes] = {}
  357. # #1790: per-printer producer-done event. Set by `on_finish_photo_moment` in its
  358. # `finally` block (whether it captured a frame or not). The consumer in
  359. # `_background_finish_photo` waits on it before reading `_stage22_finish_frames`
  360. # so the FINISH-state fallback path — where moment and completion are dispatched
  361. # back-to-back — doesn't race past the producer with an empty pop, and the
  362. # consumer's RTSP fallback can't collide with the producer's still-in-flight RTSP
  363. # grab (Bambu printers allow only one RTSP client at a time).
  364. _stage22_finish_in_flight: dict[int, asyncio.Event] = {}
  365. # #1867: rolling "last in-print camera frame" per printer. Refreshed on
  366. # layer-change and on print-progress advances (#2547) while the model is still
  367. # printing, then consumed by the FINISH-state finish-photo path when the
  368. # dispatcher recorded that it injected End G-code into this print. Bambu
  369. # reports gcode_state=FINISH AFTER the user End G-code (e.g. SwapMod
  370. # plate-swap) has run, so a live grab there would capture the swapped/empty
  371. # plate.
  372. #
  373. # The load-bearing property: both drivers are print telemetry that stops before
  374. # the End G-code executes — no further layer_num increases, and mc_percent
  375. # freezes — so the last banked frame is always the finished print before the
  376. # swap. Anything added as a third driver must hold that same property.
  377. _inprint_frame_bank: dict[int, bytes] = {}
  378. # Monotonic timestamp of the last banked frame per printer — throttles banking
  379. # so tall prints don't add a camera grab on every layer.
  380. _inprint_frame_bank_ts: dict[int, float] = {}
  381. # Minimum seconds between banked frames, except the final object layer which
  382. # always refreshes for the best framing.
  383. _INPRINT_BANK_MIN_INTERVAL = 25.0
  384. # Per-printer "connected" edge tracker. Used by `on_printer_status_change`
  385. # to fire `reconcile_stale_active_prints` exactly once per (re)connection
  386. # (#1542 follow-up — power-cycle ghost prints). The value is True after
  387. # the first connected status update for that connection; transitions back
  388. # to False whenever we observe `state.connected = False` so the next
  389. # reconnect re-arms reconciliation. Keyed by printer_id.
  390. _printer_reconciled_since_connect: dict[int, bool] = {}
  391. # Same edge, same keying, for priming the printer's calibration table exactly
  392. # once per (re)connection. Nothing else asks for it on connect: state.kprofiles
  393. # is otherwise filled only when someone opens the Profiles page or Configure
  394. # Slot, when a GitHub backup runs, or when the printer happens to answer
  395. # somebody else's query on the report topic. Until then the AMS slot card has
  396. # no K value to show on the printers whose trays carry none of their own
  397. # (#2854 — H2-series report cali_idx and nothing more).
  398. _printer_kprofiles_primed_since_connect: dict[int, bool] = {}
  399. # Track expected prints from reprint/scheduled (skip auto-archiving for these)
  400. # {(printer_id, filename): archive_id}
  401. _expected_prints: dict[tuple[int, str], int] = {}
  402. # Track AMS mapping for prints: {archive_id: [global_tray_id_per_slot]}
  403. # Used by usage tracker to map 3MF slots to physical AMS trays
  404. _print_ams_mappings: dict[int, list[int]] = {}
  405. # Track cost center selection for the current print run: {archive_id: cost_center_id}
  406. _print_cost_center_ids: dict[int, int] = {}
  407. # Track plate_id for prints from multi-plate 3MFs: {archive_id: plate_id}
  408. # Used by usage tracker to scope 3MF parsing to the dispatched plate (#1697).
  409. # Populated by direct-Print and queue dispatch paths; queue prints also have a
  410. # redundant queue-item lookup in on_print_start so this dict isn't load-bearing
  411. # for the queue path. Cleared on print completion or TTL eviction.
  412. _print_plate_ids: dict[int, int] = {}
  413. # Track progress milestones for notifications: {printer_id: last_milestone_notified}
  414. # Milestones are 25, 50, 75. Value of 0 means no milestone notified yet for current print.
  415. _last_progress_milestone: dict[int, int] = {}
  416. # Track whether first layer complete notification has been sent for current print
  417. _first_layer_notified: dict[int, bool] = {}
  418. # Track whether we already sent a kill-switch stop for the current unauthorized print
  419. _unauthorized_print_kill_sent: set[int] = set()
  420. # The MQTT status callback is a hot path. Cache the two-setting kill-switch
  421. # lookup briefly so an unknown active print does not query the database on
  422. # every status frame. A short TTL keeps settings changes responsive.
  423. _KILL_SWITCH_SETTING_CACHE_TTL_SECONDS = 5.0
  424. _kill_switch_setting_cache: tuple[bool, float] | None = None
  425. # Provider notification started when the kill switch stops a print. The later
  426. # MQTT print-complete callback awaits this task and only sends its regular
  427. # provider notification when the immediate attempt failed.
  428. _kill_switch_notification_tasks: dict[int, asyncio.Task[bool]] = {}
  429. # Track HMS errors that have been notified: {printer_id: set of error codes}
  430. # This prevents sending duplicate notifications for the same error
  431. _notified_hms_errors: dict[int, set[str]] = {}
  432. # Track when HMS errors were last seen: {printer_id: timestamp}
  433. # Used to debounce clearing — prevents flapping errors from re-triggering notifications
  434. _hms_last_seen: dict[int, float] = {}
  435. _HMS_CLEAR_GRACE_SECONDS = 30.0
  436. # Track timelapse file baselines at print start: {printer_id: set of video filenames}
  437. # Used for snapshot-diff detection at print completion
  438. _timelapse_baselines: dict[int, set[str]] = {}
  439. # Track printers waiting for bed to cool after print completion.
  440. # Event-driven: fires when bed_temper arrives via MQTT below threshold.
  441. # {printer_id: {"threshold": float, "filename": str, "registered_at": float}}
  442. _bed_cool_waiters: dict[int, dict] = {}
  443. # Track printers where the user explicitly stopped the print from the queue UI.
  444. # When on_print_complete fires with status "failed" for these printers we treat it
  445. # as "cancelled" (stopped by user) so the correct notification email is sent.
  446. _user_stopped_printers: set[int] = set()
  447. # Offline-notification edge state (#1752): fire `on_printer_offline` exactly
  448. # once when a printer transitions connected → disconnected. `_printer_last_connected`
  449. # holds the previous observation so we only fire on the True → False edge (a
  450. # False → False repeat doesn't notify; an initial False at startup doesn't
  451. # notify either, since there's no prior True). `_printer_offline_notify_tasks`
  452. # holds the per-printer pending asyncio task that fires the notification
  453. # after a debounce window — cancelled if the printer reconnects before the
  454. # window elapses, so transient MQTT blips don't flood the user.
  455. _printer_last_connected: dict[int, bool] = {}
  456. _printer_offline_notify_tasks: dict[int, asyncio.Task] = {}
  457. # Debounce: a printer must stay offline this long before we notify. Sized
  458. # against the staleness path (`bambu_mqtt.py::STALE_RECONNECT_COOLDOWN = 30s`)
  459. # so a single stale-trigger cooldown isn't enough to fire — only a real
  460. # offline that survives one reconnect attempt notifies.
  461. _PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS = 60.0
  462. # HMS short-code → failure_reason key. Used by _dispatch_archive_update
  463. # when status="failed" to label the print's failure_reason in archives.
  464. #
  465. # Earlier code matched on `module` alone (e.g. "any module 0x0C HMS → Layer shift"),
  466. # which is wrong on two counts:
  467. # 1. Real layer-shift codes live in module 0x03 (see Bambu wiki), not 0x0C.
  468. # 2. Module 0x0C is "Motion Controller" — broad category that also covers cameras
  469. # and visual markers, AND the H2D firmware emits a 0x0C HMS (0C00_001B, not in
  470. # the public wiki) as part of its user-cancel sequence. Matching on the module
  471. # alone caused user-cancellations to be archived as "Layer shift" failures.
  472. # We now match by full short code only — anything not in this map leaves
  473. # failure_reason=None rather than guessing.
  474. # Values are the canonical camelCase failure-reason keys, NOT display labels
  475. # (issue #2974). The vocabulary is enforced on writes by
  476. # ``_FAILURE_REASON_KEYS`` in ``api/routes/print_log.py`` and rendered through
  477. # ``t('editArchive.failureReasons.<key>')`` on both the archive editor and the
  478. # Statistics breakdown. Storing a label here instead put a second spelling of
  479. # the same cause into one column: the Failure Analysis widget groups on the raw
  480. # value, so a print the backend classified and an identical one a user
  481. # classified counted as two different reasons, and the label form could never
  482. # be translated because there was no key for ``t()`` to resolve.
  483. _HMS_FAILURE_REASONS: dict[str, str] = {
  484. # Layer shift / step loss
  485. "0300_4057": "layerShift",
  486. "0300_4068": "layerShift",
  487. "0300_800C": "layerShift",
  488. # Filament runout (printer-side & per-AMS-slot)
  489. "0300_8004": "filamentRunout",
  490. "0700_8011": "filamentRunout",
  491. "0701_8011": "filamentRunout",
  492. "0702_8011": "filamentRunout",
  493. "0703_8011": "filamentRunout",
  494. "0704_8011": "filamentRunout",
  495. "0705_8011": "filamentRunout",
  496. "0706_8011": "filamentRunout",
  497. "0707_8011": "filamentRunout",
  498. "07FF_8011": "filamentRunout",
  499. # Clogged nozzle / extruder
  500. "0300_4006": "cloggedNozzle",
  501. "0300_8016": "cloggedNozzle",
  502. "0300_801C": "cloggedNozzle",
  503. "0700_8003": "cloggedNozzle",
  504. "0700_8007": "cloggedNozzle",
  505. "0700_8013": "cloggedNozzle",
  506. "0701_8003": "cloggedNozzle",
  507. "0701_8007": "cloggedNozzle",
  508. "0701_8013": "cloggedNozzle",
  509. "0702_8003": "cloggedNozzle",
  510. # AI print monitoring — spaghetti / the model coming off the plate.
  511. # `spaghettiDetached` is a key the archive editor already offers for this
  512. # failure mode, not a new one, so a derived reason opens the dropdown on
  513. # that option rather than blank — and survives the next save, which clears
  514. # any value the editor does not recognise.
  515. #
  516. # A module-0x0C row is safe here despite the warning above: that warning is
  517. # about matching on the module alone, and 0C00_8042 is a full short code
  518. # with a documented meaning ("The AI print monitor has detected a spaghetti
  519. # defect", hms_errors.py). The H2D cancel echo is 0C00_001B, so the two
  520. # cannot collide.
  521. #
  522. # 0300_8003's own text ends "before continuing your print", but on an X2D
  523. # it arrives with the print already paused, offering only
  524. # RESUME_PRINTING_DEFECTS / STOP_PRINTING — a halt waiting on the user.
  525. #
  526. # Two neighbours are left out on purpose, so this does not get re-derived:
  527. # * 0C00_C004 "Possible spaghetti failure was detected." — "possible"
  528. # reads as a warning about a print that is still running, not a halt.
  529. # * 0300_800A is AI monitoring too, but it reports a filament pile-up in
  530. # the waste chute. That is not the print failing.
  531. #
  532. # That line is drawn from the text, not from `severity`, because severity
  533. # cannot draw it: 0300_8003 reaches us through `print_error`, a bare
  534. # module/error word with no level in it, and bambu_mqtt.py gives every
  535. # print_error entry a flat severity=3. Matching on the short code alone is
  536. # the right shape for derive_failure_reason, not an omission.
  537. "0300_8003": "spaghettiDetached",
  538. "0C00_8042": "spaghettiDetached",
  539. }
  540. def _hms_short_code(attr: int, code: int | str) -> str:
  541. """Build the canonical "MMMM_CCCC" HMS short code from raw attr/code values."""
  542. if isinstance(code, str):
  543. code_int = int(code.replace("0x", ""), 16) if code else 0
  544. else:
  545. code_int = int(code or 0)
  546. attr_int = int(attr or 0)
  547. return f"{(attr_int >> 16) & 0xFFFF:04X}_{code_int & 0xFFFF:04X}"
  548. def derive_failure_reason(status: str, hms_errors: list[dict] | None) -> str | None:
  549. """Derive the failure_reason key for an archived print.
  550. Returns "userCancelled" for cancelled/aborted prints; for failed prints,
  551. returns the first matching key from _HMS_FAILURE_REASONS, or None when
  552. no HMS code matches (don't guess — null is honest). The keys are the
  553. archive editor's vocabulary (_FAILURE_REASON_KEYS in print_log.py) and are
  554. translated at render time.
  555. """
  556. if status in ("aborted", "cancelled"):
  557. return "userCancelled"
  558. if status != "failed":
  559. return None
  560. for err in hms_errors or []:
  561. short_code = _hms_short_code(err.get("attr", 0), err.get("code", 0))
  562. if short_code in _HMS_FAILURE_REASONS:
  563. return _HMS_FAILURE_REASONS[short_code]
  564. return None
  565. # Track created_by_id for expected prints so the user email can be sent even when
  566. # the archive itself doesn't have created_by_id set (e.g. library-file-based prints).
  567. # {(printer_id, filename): created_by_id}
  568. _expected_print_creators: dict[tuple[int, str], int] = {}
  569. # Per-printer lock that serialises the spool-assignment side of on_ams_change
  570. # (auto-unlink stale + auto-assign new) when MQTT bursts deliver multiple AMS
  571. # updates for the same printer in quick succession (~30 ms apart, observed in
  572. # the wild on H2D + dual AMS).
  573. #
  574. # Without this serialisation, two concurrent on_ams_change callbacks each read
  575. # "no assignment for (printer, ams, tray)", each call auto_assign_spool, and
  576. # the second commit hits
  577. # IntegrityError: duplicate key value violates unique constraint
  578. # "spool_assignment_printer_id_ams_id_tray_id_key"
  579. # SQLite's WAL serial-write semantics had been silently swallowing the race
  580. # until optional Postgres support landed (asyncpg allows true concurrent
  581. # transactions and surfaces the constraint violation).
  582. #
  583. # Scope is intentionally narrow: only the two DB-mutating blocks (unlink +
  584. # assign) are inside the lock. The Spoolman sync block further down stays
  585. # concurrent because it's network-bound and idempotent.
  586. _ams_assignment_locks: dict[int, asyncio.Lock] = {}
  587. def _get_ams_assignment_lock(printer_id: int) -> asyncio.Lock:
  588. """Return the per-printer assignment lock, creating it on first use."""
  589. lock = _ams_assignment_locks.get(printer_id)
  590. if lock is None:
  591. lock = asyncio.Lock()
  592. _ams_assignment_locks[printer_id] = lock
  593. return lock
  594. # Per-printer dedup for unknown_tag WS broadcasts. Keyed by
  595. # (ams_id, tray_id) -> (tag_uid, tray_uuid); we only re-broadcast when the
  596. # tag tuple changes for the slot. Cleared when the slot is reported empty
  597. # so remove + reinsert reliably re-prompts the UI.
  598. _unknown_tag_last_broadcast: dict[int, dict[tuple[int, int], tuple[str, str]]] = {}
  599. async def _broadcast_unknown_tag(
  600. *,
  601. printer_id: int,
  602. ams_id: int,
  603. tray_id: int,
  604. tag_uid: str,
  605. tray_uuid: str,
  606. tray_type: str | None = None,
  607. tray_color: str | None = None,
  608. tray_sub_brands: str | None = None,
  609. tray_count: int | None = None,
  610. ) -> None:
  611. """Broadcast unknown_tag, deduped so repeated MQTT pushes for the same slot+tag don't spam the UI."""
  612. _logger = logging.getLogger(__name__)
  613. slot_key = (ams_id, tray_id)
  614. tag_key = (tag_uid or "", tray_uuid or "")
  615. per_printer = _unknown_tag_last_broadcast.setdefault(printer_id, {})
  616. if per_printer.get(slot_key) == tag_key:
  617. _logger.debug(
  618. "unknown_tag deduped for printer=%d AMS=%d slot=%d tag=%s",
  619. printer_id,
  620. ams_id,
  621. tray_id,
  622. tag_key[0][:8] or tag_key[1][:8] or "(none)",
  623. )
  624. return
  625. _logger.info(
  626. "unknown_tag broadcast: printer=%d AMS=%d slot=%d type=%r color=%r tag=%s",
  627. printer_id,
  628. ams_id,
  629. tray_id,
  630. tray_type,
  631. tray_color,
  632. tag_key[0][:8] or tag_key[1][:8] or "(none)",
  633. )
  634. # Broadcast first; only commit the dedup if the WS write succeeds.
  635. # If broadcast raises, the next MQTT push retries instead of being
  636. # permanently silenced by a poisoned dedup entry.
  637. await ws_manager.broadcast(
  638. {
  639. "type": "unknown_tag",
  640. "printer_id": printer_id,
  641. "ams_id": ams_id,
  642. "tray_id": tray_id,
  643. "tag_uid": tag_uid,
  644. "tray_uuid": tray_uuid,
  645. "tray_type": tray_type,
  646. "tray_color": tray_color,
  647. "tray_sub_brands": tray_sub_brands,
  648. "tray_count": tray_count,
  649. }
  650. )
  651. per_printer[slot_key] = tag_key
  652. def _clear_unknown_tag_dedup(printer_id: int, ams_id: int, tray_id: int) -> None:
  653. """Drop the cached last-broadcast tag for a slot (called when slot reports empty or gets matched)."""
  654. per_printer = _unknown_tag_last_broadcast.get(printer_id)
  655. if per_printer is None:
  656. return
  657. per_printer.pop((ams_id, tray_id), None)
  658. # TTL for expected-print entries: evict registrations older than this to prevent
  659. # unbounded growth when a print is registered but never starts (e.g. printer
  660. # disconnect, app restart, print started from the printer panel).
  661. _EXPECTED_PRINT_TTL_SECONDS: int = 2 * 60 * 60 # 2 hours
  662. # Registration timestamps used for TTL eviction: {(printer_id, filename): monotonic_time}
  663. _expected_print_registered_at: dict[tuple[int, str], float] = {}
  664. # Cleanup loop interval
  665. _EXPECTED_PRINT_CLEANUP_INTERVAL: int = 15 * 60 # 15 minutes
  666. _expected_prints_cleanup_task: asyncio.Task | None = None
  667. _ACTIVE_PRINT_STATES: set[str] = {"RUNNING", "PRINTING", "PAUSE"}
  668. def _build_status_print_keys(printer_id: int, state: PrinterState) -> list[tuple[int, str]]:
  669. """Build filename keys for matching a printer status update to Bambuddy-owned jobs."""
  670. possible_keys: list[tuple[int, str]] = []
  671. filename = (state.gcode_file or state.current_print or "").strip()
  672. subtask_name = (state.subtask_name or "").strip()
  673. if subtask_name:
  674. possible_keys.append((printer_id, subtask_name))
  675. possible_keys.append((printer_id, f"{subtask_name}.3mf"))
  676. possible_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
  677. if filename:
  678. base_name = filename.rsplit("/", 1)[-1]
  679. if base_name.endswith(".gcode.3mf"):
  680. root_name = base_name[: -len(".gcode.3mf")]
  681. possible_keys.append((printer_id, root_name))
  682. possible_keys.append((printer_id, base_name))
  683. possible_keys.append((printer_id, f"{root_name}.gcode"))
  684. possible_keys.append((printer_id, f"{root_name}.3mf"))
  685. elif base_name.endswith(".3mf"):
  686. root_name = base_name[: -len(".3mf")]
  687. possible_keys.append((printer_id, root_name))
  688. possible_keys.append((printer_id, base_name))
  689. elif base_name.endswith(".gcode"):
  690. root_name = base_name[: -len(".gcode")]
  691. possible_keys.append((printer_id, root_name))
  692. possible_keys.append((printer_id, f"{root_name}.3mf"))
  693. possible_keys.append((printer_id, base_name))
  694. else:
  695. possible_keys.append((printer_id, base_name))
  696. possible_keys.append((printer_id, f"{base_name}.3mf"))
  697. return possible_keys
  698. def _is_bambuddy_authorized_print_in_memory(printer_id: int, state: PrinterState) -> bool:
  699. """Check the cheap, process-local print ownership signals."""
  700. if printer_manager.get_current_print_user(printer_id):
  701. return True
  702. return any(key in _expected_prints or key in _active_prints for key in _build_status_print_keys(printer_id, state))
  703. async def _is_printer_kill_switch_enabled_cached() -> bool:
  704. """Return the kill-switch setting without querying on every MQTT frame."""
  705. global _kill_switch_setting_cache
  706. now = time.monotonic()
  707. if _kill_switch_setting_cache is not None:
  708. enabled, expires_at = _kill_switch_setting_cache
  709. if now < expires_at:
  710. return enabled
  711. async with async_session() as db:
  712. from backend.app.services.finance_budget import is_printer_kill_switch_enabled
  713. enabled = await is_printer_kill_switch_enabled(db)
  714. _kill_switch_setting_cache = (enabled, now + _KILL_SWITCH_SETTING_CACHE_TTL_SECONDS)
  715. return enabled
  716. async def _is_bambuddy_authorized_print(printer_id: int, state: PrinterState, db) -> bool | None:
  717. """Resolve whether the current print was started by Bambuddy.
  718. ``None`` means identity is not yet safe to decide. The kill switch must
  719. defer in that case: stopping a print is irreversible, and the first status
  720. frames after a restart may arrive before all subtask fields are populated.
  721. """
  722. if _is_bambuddy_authorized_print_in_memory(printer_id, state):
  723. return True
  724. possible_keys = _build_status_print_keys(printer_id, state)
  725. # In-memory ownership is lost on every Bambuddy restart, so fall back to what
  726. # is on disk. subtask_id is minted per print and pins the answer to the job
  727. # actually running, rather than to an unrelated one that reuses a filename.
  728. raw_subtask_id = getattr(state, "subtask_id", None)
  729. subtask_id = str(raw_subtask_id).strip() if raw_subtask_id is not None else ""
  730. if subtask_id in ("", "0"):
  731. return None
  732. from backend.app.models.archive import PrintArchive
  733. result = await db.execute(
  734. select(PrintArchive)
  735. .where(
  736. PrintArchive.printer_id == printer_id,
  737. PrintArchive.status == "printing",
  738. PrintArchive.subtask_id == subtask_id,
  739. )
  740. .order_by(PrintArchive.created_at.desc())
  741. .limit(1)
  742. )
  743. archive = result.scalar_one_or_none()
  744. # An archive row on its own proves nothing: `on_print_start` archives every
  745. # print it observes, including ones started from Bambu Studio or Handy, and
  746. # stamps them with the same status and subtask_id. Authorizing on its mere
  747. # existence would disable the kill switch the moment the 3MF finishes
  748. # downloading. Only a dispatch marker Bambuddy writes itself counts —
  749. # `billing_run_id` (minted per dispatch in the scheduler) or `created_by_id`
  750. # (carried over from the queue item that started it).
  751. if archive is not None and (archive.billing_run_id is not None or archive.created_by_id is not None):
  752. # Rehydrate the fast in-memory path for subsequent status frames. Include
  753. # both the archive filename and every normalized key reported by MQTT.
  754. _active_prints[(printer_id, archive.filename)] = archive.id
  755. for key in possible_keys:
  756. _active_prints[key] = archive.id
  757. return True
  758. # No dispatch marker. Before calling this someone else's print, check whether
  759. # Bambuddy has a job of its own running on this printer: a library-file
  760. # dispatch has no archive at send time, and an archive created seconds later
  761. # by `on_print_start` carries neither marker. The queue row, which the
  762. # scheduler commits to status="printing" before the MQTT send, is the one
  763. # durable record every Bambuddy print has. It cannot be tied to this
  764. # subtask_id, so it is grounds to defer, never to authorize — stopping a
  765. # print is irreversible, and refusing to act costs nothing but a log line.
  766. from backend.app.models.print_queue import PrintQueueItem
  767. dispatched_here = await db.scalar(
  768. select(PrintQueueItem.id)
  769. .where(
  770. PrintQueueItem.printer_id == printer_id,
  771. PrintQueueItem.status == "printing",
  772. )
  773. .limit(1)
  774. )
  775. if dispatched_here is not None:
  776. return None
  777. return False
  778. async def _send_kill_switch_provider_notification(
  779. printer_id: int,
  780. printer_name: str,
  781. data: dict,
  782. ) -> bool:
  783. """Send the immediate print-stopped provider notification.
  784. Returning a success flag lets the normal MQTT completion path retry when
  785. this early notification could not be delivered.
  786. """
  787. logger = logging.getLogger(__name__)
  788. try:
  789. async with async_session() as db:
  790. await notification_service.on_print_complete(
  791. printer_id,
  792. printer_name,
  793. "stopped",
  794. data,
  795. db,
  796. )
  797. return True
  798. except Exception as e:
  799. logger.warning(
  800. "[KILL SWITCH] Immediate provider notification failed for printer %s: %s",
  801. printer_id,
  802. e,
  803. )
  804. return False
  805. async def _kill_switch_notification_already_sent(task: asyncio.Task[bool] | None) -> bool:
  806. """Wait for an immediate kill-switch notification, if one was scheduled."""
  807. if task is None:
  808. return False
  809. try:
  810. return await task
  811. except Exception as e:
  812. logging.getLogger(__name__).warning("[KILL SWITCH] Notification task failed: %s", e)
  813. return False
  814. async def _get_plug_energy(plug, db) -> dict | None:
  815. """Get energy from plug regardless of type (Tasmota, Home Assistant, MQTT, or REST).
  816. For HA plugs, configures the service with current settings from DB.
  817. For MQTT plugs, returns data from the subscription service.
  818. For REST plugs, polls the status URL with JSON path extraction.
  819. """
  820. if plug.plug_type == "homeassistant":
  821. from backend.app.api.routes.settings import get_homeassistant_settings
  822. ha_settings = await get_homeassistant_settings(db)
  823. homeassistant_service.configure(ha_settings["ha_url"], ha_settings["ha_token"])
  824. return await homeassistant_service.get_energy(plug)
  825. elif plug.plug_type == "mqtt":
  826. # MQTT plugs report "today" energy, not lifetime total
  827. # For per-print tracking, we use "today" as the counter (resets at midnight)
  828. mqtt_data = mqtt_relay.smart_plug_service.get_plug_data(plug.id)
  829. if mqtt_data:
  830. return {
  831. "power": mqtt_data.power,
  832. "today": mqtt_data.energy,
  833. "total": mqtt_data.energy, # Use today as total for per-print calculations
  834. }
  835. return None
  836. elif plug.plug_type == "rest":
  837. from backend.app.services.rest_smart_plug import rest_smart_plug_service
  838. return await rest_smart_plug_service.get_energy(plug)
  839. else:
  840. return await tasmota_service.get_energy(plug)
  841. async def _record_energy_start(archive, printer_id: int, db, *, context: str = "") -> bool:
  842. """Capture the smart plug lifetime counter on the archive at print start.
  843. Persists `energy_start_kwh` on the archive row (#941) so per-print energy
  844. tracking survives a backend restart mid-print. The print-end handler reads
  845. this value back from the DB and computes the delta against the current
  846. plug counter.
  847. """
  848. _logger = logging.getLogger(__name__)
  849. try:
  850. candidates = await energy_plug_candidates(db, printer_id)
  851. if not candidates:
  852. _logger.info("[ENERGY] No smart plug for printer %s (archive %s)", printer_id, archive.id)
  853. return False
  854. selected = await select_energy_reading(candidates, _get_plug_energy, db)
  855. if selected is None:
  856. # Naming the plugs matters here: with several linked to one printer
  857. # this is the difference between "the meter is offline" and "you
  858. # linked only accessories" (#2859).
  859. _logger.warning(
  860. "[ENERGY] No plug on printer %s reports a lifetime energy counter for archive %s (tried: %s)",
  861. printer_id,
  862. archive.id,
  863. ", ".join(plug.name for plug in candidates),
  864. )
  865. return False
  866. plug, energy = selected
  867. archive.energy_start_kwh = float(energy["total"])
  868. await db.commit()
  869. _logger.info(
  870. "[ENERGY] Recorded starting energy%s for archive %s from plug '%s': %s kWh",
  871. f" ({context})" if context else "",
  872. archive.id,
  873. plug.name,
  874. energy["total"],
  875. )
  876. return True
  877. except Exception as e:
  878. _logger.warning("[ENERGY] Failed to record starting energy for archive %s: %s", archive.id, e)
  879. return False
  880. def register_expected_print(
  881. printer_id: int,
  882. filename: str,
  883. archive_id: int,
  884. ams_mapping: list[int] | None = None,
  885. created_by_id: int | None = None,
  886. cost_center_id: int | None = None,
  887. plate_id: int | None = None,
  888. ):
  889. """Register an expected print from reprint/scheduled so we don't create duplicate archives."""
  890. # Store with multiple filename variations to catch different naming patterns
  891. _expected_prints[(printer_id, filename)] = archive_id
  892. # Also store without .3mf extension if present
  893. if filename.endswith(".3mf"):
  894. base = filename[:-4]
  895. _expected_prints[(printer_id, base)] = archive_id
  896. _expected_prints[(printer_id, f"{base}.gcode")] = archive_id
  897. # Store AMS mapping for usage tracking at print completion
  898. if ams_mapping is not None:
  899. _print_ams_mappings[archive_id] = ams_mapping
  900. if cost_center_id is not None:
  901. _print_cost_center_ids[archive_id] = cost_center_id
  902. # Store plate_id for usage tracking when this is a single-plate dispatch from
  903. # a multi-plate 3MF — without this, the direct-Print path attributes the whole
  904. # file's filament total to the spool instead of just the printed plate (#1697).
  905. if plate_id is not None:
  906. _print_plate_ids[archive_id] = plate_id
  907. # Store created_by_id so the user start email can be sent even when the archive
  908. # itself has no created_by_id (e.g. library-file-based queue prints)
  909. if created_by_id is not None:
  910. _expected_print_creators[(printer_id, filename)] = created_by_id
  911. if filename.endswith(".3mf"):
  912. base = filename[:-4]
  913. _expected_print_creators[(printer_id, base)] = created_by_id
  914. _expected_print_creators[(printer_id, f"{base}.gcode")] = created_by_id
  915. # Record registration time for TTL-based eviction
  916. _registered_at = time.monotonic()
  917. _expected_print_registered_at[(printer_id, filename)] = _registered_at
  918. if filename.endswith(".3mf"):
  919. base = filename[:-4]
  920. _expected_print_registered_at[(printer_id, base)] = _registered_at
  921. _expected_print_registered_at[(printer_id, f"{base}.gcode")] = _registered_at
  922. logging.getLogger(__name__).info(
  923. f"Registered expected print: printer={printer_id}, file={filename}, archive={archive_id}, ams_mapping={ams_mapping}, plate_id={plate_id}"
  924. )
  925. def unregister_expected_print(printer_id: int, filename: str, archive_id: int) -> None:
  926. """Undo :func:`register_expected_print` when the print never went out.
  927. Registration has to happen *before* the MQTT print command, because the
  928. printer can report the print before the line after the send executes. So
  929. every path that registers and then fails to send — a cancel winning the
  930. #1853 CAS race, a ``start_print()`` that returns False, or any exception in
  931. between — leaves an expectation for a print that will never arrive.
  932. The TTL sweep evicts those after two hours, which is far longer than it
  933. takes a user to react to a failed dispatch by pressing print again: that
  934. reprint would be folded into the *old* archive and take the stale
  935. ``ams_mapping`` / ``plate_id`` with it. Hence the explicit inverse.
  936. Mirrors the sweep's rules, including the one that is easy to get wrong:
  937. ``_print_ams_mappings`` / ``_print_plate_ids`` are keyed by archive, not by
  938. file, so they may only be dropped once no live key still points at that
  939. archive.
  940. """
  941. keys = [(printer_id, filename)]
  942. if filename.endswith(".3mf"):
  943. base = filename[:-4]
  944. keys.append((printer_id, base))
  945. keys.append((printer_id, f"{base}.gcode"))
  946. removed = False
  947. for key in keys:
  948. if _expected_prints.pop(key, None) is not None:
  949. removed = True
  950. _expected_print_creators.pop(key, None)
  951. _expected_print_registered_at.pop(key, None)
  952. if archive_id not in set(_expected_prints.values()):
  953. _print_ams_mappings.pop(archive_id, None)
  954. _print_plate_ids.pop(archive_id, None)
  955. if removed:
  956. logging.getLogger(__name__).info(
  957. "Unregistered expected print: printer=%s, file=%s, archive=%s (print was never sent)",
  958. printer_id,
  959. filename,
  960. archive_id,
  961. )
  962. def _compute_run_filament_grams(
  963. status: str,
  964. archive_filament_used_grams: float | None,
  965. progress: float | int | None,
  966. usage_results: list[dict] | None,
  967. ) -> float | None:
  968. """Per-run filament for PrintLogEntry, partial- and tracker-aware (#1378, #1390).
  969. Priority for every status:
  970. 1. Sum of tracked spool deltas in ``usage_results`` (AMS-measured
  971. weight delta — same source that drives "Total Consumed" on the
  972. Inventory page, so Stats and Inventory totals stay aligned).
  973. 2. For ``completed``: the slicer estimate (no tracker available, fall
  974. back to the canonical "this print used X" value).
  975. 3. For partial statuses: ``estimate * progress%``.
  976. 4. ``None`` if nothing is known.
  977. """
  978. tracked_grams = sum(r.get("weight_used") or 0 for r in (usage_results or []))
  979. if tracked_grams > 0:
  980. return round(tracked_grams, 1)
  981. if status == "completed":
  982. return archive_filament_used_grams
  983. if archive_filament_used_grams:
  984. scale = max(0.0, min(((progress or 0) / 100.0), 1.0))
  985. if scale > 0:
  986. return round(archive_filament_used_grams * scale, 1)
  987. return None
  988. def _get_start_ams_mapping(data: dict, archive_id: int | None) -> list[int] | None:
  989. """Resolve AMS mapping for print start without consuming stored queue/reprint state."""
  990. stored_ams_mapping = data.get("ams_mapping")
  991. if not stored_ams_mapping and archive_id:
  992. stored_ams_mapping = _print_ams_mappings.get(archive_id)
  993. return stored_ams_mapping
  994. def _get_start_plate_id(archive_id: int | None) -> int | None:
  995. """Resolve plate_id for print start without consuming stored direct-Print state.
  996. Direct-Print of a single plate from a multi-plate 3MF registers plate_id in
  997. ``_print_plate_ids`` at dispatch time; this lets the spoolman / usage tracker
  998. read it back at print-start without popping (the entry is popped on print
  999. completion or TTL eviction, mirroring ``_print_ams_mappings``).
  1000. """
  1001. if archive_id is None:
  1002. return None
  1003. return _print_plate_ids.get(archive_id)
  1004. def _partial_progress_scale(progress: int | float | None) -> float:
  1005. """Clamp ``progress / 100`` into [0.0, 1.0] for partial-print scaling.
  1006. Used by every site that multiplies a "would-have-used" slicer estimate
  1007. down to "actually-used" for failed / cancelled / stopped prints. Centralised
  1008. so the three sites in ``_background_notifications`` (and the per-plate
  1009. override helper) can't drift apart on the coercion shape.
  1010. """
  1011. return max(0.0, min((progress or 0) / 100.0, 1.0))
  1012. def _scope_notification_archive_data_to_plate(
  1013. archive_data: dict,
  1014. archive_file_path: str | None,
  1015. plate_id: int | None,
  1016. print_status: str,
  1017. progress: int | float | None,
  1018. base_dir: Path,
  1019. ) -> dict:
  1020. """Override summed-across-plates totals in ``archive_data`` with the values
  1021. for ``plate_id`` so the completion notification reports what was actually
  1022. printed, not the whole project (#1785).
  1023. The 3MF parser at services/archive.py:200-264 sums ``prediction`` and
  1024. ``weight`` across every plate of a multi-plate file (#1593) — correct for
  1025. the archive card's "whole project" headline, wrong for the completion
  1026. notification of a single-plate print. The queue UI already re-reads the
  1027. 3MF per-plate at print_queue.py:272-285; this helper mirrors that for the
  1028. notification payload (filament grams, time estimate, per-slot breakdown).
  1029. No-ops when ``plate_id`` is None, the file is missing, or the 3MF carries
  1030. no per-plate values — in every fail case the original ``archive_data`` is
  1031. returned unchanged so the notification still sends.
  1032. """
  1033. if plate_id is None or not archive_file_path:
  1034. return archive_data
  1035. from backend.app.utils.threemf_tools import (
  1036. extract_filament_usage_from_3mf,
  1037. extract_print_time_from_3mf,
  1038. )
  1039. archive_path = base_dir / archive_file_path
  1040. if not archive_path.exists():
  1041. return archive_data
  1042. plate_slots = extract_filament_usage_from_3mf(archive_path, plate_id)
  1043. plate_grams = sum(f.get("used_g", 0) for f in plate_slots)
  1044. plate_time = extract_print_time_from_3mf(archive_path, plate_id)
  1045. scale = 1.0 if print_status == "completed" else _partial_progress_scale(progress)
  1046. if plate_time:
  1047. archive_data["print_time_seconds"] = plate_time
  1048. # Gate both the grams headline AND the per-slot breakdown on the same
  1049. # `plate_grams > 0` signal: if the 3MF carries per-plate filament rows but
  1050. # they all sum to zero (slicer bug / re-slice without estimate), drop back
  1051. # to the project-level grams the archive columns already provide rather
  1052. # than ship a project-level headline next to an all-zero per-plate
  1053. # breakdown.
  1054. if plate_grams > 0:
  1055. archive_data["actual_filament_grams"] = round(plate_grams * scale, 1)
  1056. archive_data["filament_slots"] = [
  1057. {
  1058. "slot_id": s.get("slot_id"),
  1059. "used_g": round((s.get("used_g") or 0) * scale, 1),
  1060. "type": s.get("type", ""),
  1061. "color": s.get("color", ""),
  1062. }
  1063. for s in plate_slots
  1064. ]
  1065. return archive_data
  1066. def _extract_filament_data_from_mqtt(data: dict, ams_mapping: list[int] | None = None) -> dict[str, str]:
  1067. """Best-effort filament metadata from the MQTT print-start snapshot.
  1068. Used when the 3MF can't be downloaded (P1S/A1/P2S firmwares lock the
  1069. file during print, see #1533) so the fallback PrintArchive still has
  1070. enough filament info to support the inventory views and AMS-expansion
  1071. planning the operator opens it for. Returns a dict with optional
  1072. ``filament_type`` and ``filament_color`` keys in the same
  1073. comma-separated format the 3MF extractor produces, so the rest of the
  1074. codebase treats the fallback archive identically to a normal one.
  1075. ``ams_mapping`` is the slicer's slot-per-print-filament list captured
  1076. from the MQTT print payload (global tray IDs, possibly -1 for VT-tray
  1077. entries). When supplied, only the slots actually consumed by this
  1078. print contribute. Without it the function falls back to every loaded
  1079. AMS slot — less accurate but still useful.
  1080. Accepts both the raw inner payload (``{"ams": {"ams": [...]}, ...}``)
  1081. that the unit tests pass directly, AND the on_print_start callback
  1082. shape (``{"raw_data": {"ams": {"ams": [...]}, ...}, ...}``) the
  1083. bambu_mqtt service hands to main.py at runtime. The original
  1084. ``_extract_filament_data_from_mqtt(data)`` shipped in #1533 only
  1085. handled the inner shape and silently returned ``{}`` for every real
  1086. print start, leaving fallback archives' filament fields NULL — the
  1087. exact regression the fix was meant to close. Reported with a log
  1088. proving the AMS state was right there at
  1089. ``data["raw_data"]["ams"]["ams"][0]["tray"][0]`` (#1533 follow-up).
  1090. """
  1091. result: dict[str, str] = {}
  1092. # Look at the on_print_start wrapper first, then the inner shape.
  1093. raw_data = (data or {}).get("raw_data")
  1094. ams_root = (raw_data or {}).get("ams") if isinstance(raw_data, dict) else None
  1095. if not isinstance(ams_root, dict):
  1096. ams_root = (data or {}).get("ams") or {}
  1097. ams_units = ams_root.get("ams") if isinstance(ams_root, dict) else None
  1098. if not isinstance(ams_units, list) or not ams_units:
  1099. return result
  1100. # Map global tray id (unit * 4 + tray) → (type, color).
  1101. loaded: dict[int, tuple[str, str]] = {}
  1102. for unit in ams_units:
  1103. if not isinstance(unit, dict):
  1104. continue
  1105. try:
  1106. unit_id = int(unit.get("id", 0))
  1107. except (TypeError, ValueError):
  1108. continue
  1109. for tray in unit.get("tray") or []:
  1110. if not isinstance(tray, dict):
  1111. continue
  1112. try:
  1113. tray_id = int(tray.get("id", 0))
  1114. except (TypeError, ValueError):
  1115. continue
  1116. ttype = (tray.get("tray_type") or "").strip()
  1117. tcolor = (tray.get("tray_color") or "").strip().upper()
  1118. if not ttype:
  1119. continue # Empty / unloaded slot.
  1120. loaded[unit_id * 4 + tray_id] = (ttype, tcolor)
  1121. if not loaded:
  1122. return result
  1123. if ams_mapping:
  1124. used_ids = [int(x) for x in ams_mapping if isinstance(x, (int, float)) and int(x) >= 0]
  1125. filaments = [loaded[g] for g in used_ids if g in loaded]
  1126. if not filaments:
  1127. return result # Mapping points entirely at slots we have no data for.
  1128. else:
  1129. filaments = [loaded[g] for g in sorted(loaded.keys())]
  1130. types_joined = ",".join(f[0] for f in filaments)
  1131. colors_joined = ",".join(f[1] for f in filaments if f[1])
  1132. # Column limits per backend/app/models/archive.py: filament_type=50,
  1133. # filament_color=200.
  1134. if types_joined:
  1135. result["filament_type"] = types_joined[:50]
  1136. if colors_joined:
  1137. result["filament_color"] = colors_joined[:200]
  1138. return result
  1139. def _maybe_start_layer_timelapse(printer, printer_id: int, archive_id: int) -> bool:
  1140. """Start a layer-timelapse session for *archive_id* when the printer has
  1141. an external camera configured. Returns True if a session was started.
  1142. Three call sites in on_print_start (expected-archive promotion, fallback
  1143. archive creation, fresh-archive creation) used to inline this same
  1144. if-block; the inline copies kept drifting (#1353 fixed only one of them
  1145. on the first pass). Centralising the conditional + call here makes the
  1146. contract testable in isolation and keeps the three sites locked in step.
  1147. """
  1148. if not (printer.external_camera_enabled and printer.external_camera_url):
  1149. return False
  1150. from backend.app.services.layer_timelapse import start_session
  1151. start_session(
  1152. printer_id,
  1153. archive_id,
  1154. printer.external_camera_url,
  1155. printer.external_camera_type or "mjpeg",
  1156. snapshot_url=printer.external_camera_snapshot_url,
  1157. rotation=getattr(printer, "camera_rotation", 0),
  1158. )
  1159. logging.getLogger(__name__).info("Started layer timelapse for printer %s, archive %s", printer_id, archive_id)
  1160. return True
  1161. def _format_hms_error_summary(hms_errors: list[dict]) -> str | None:
  1162. """Build a human-readable failure reason from MQTT hms_errors for PrintQueueItem.error_message.
  1163. Each entry has keys: code ('0x4038'), attr (32-bit int), module, severity, and
  1164. — since #2926 — the description the parser already resolved, which is preferred
  1165. when present so the queue's failure reason reads the same as the status
  1166. response. The short code still produces the bracketed label, and still
  1167. resolves the sentence for a caller whose entries predate the field. An entry
  1168. with a 16-char ``full_code`` is labelled with it instead, since the short code
  1169. of an ``hms[]`` fault is not a code anyone can look up. Falls back to the bare
  1170. label when no description is on file. Returns None for an empty list so
  1171. callers can leave error_message unset.
  1172. """
  1173. if not hms_errors:
  1174. return None
  1175. from backend.app.services.hms_errors import get_error_description
  1176. parts: list[str] = []
  1177. for err in hms_errors:
  1178. try:
  1179. # `_hms_short_code` rather than a local derivation: this one used to
  1180. # format the error without masking it to 16 bits, so an `hms[]` entry
  1181. # whose code carries an alert-level group produced a five-digit label
  1182. # like "0500_3000A" — not a code the user can look up, and never a
  1183. # catalogue key, so the sentence was lost with it.
  1184. short_code = _hms_short_code(err.get("attr", 0), err.get("code", 0))
  1185. except (TypeError, ValueError):
  1186. continue
  1187. description = err.get("description") or get_error_description(short_code)
  1188. # An `hms[]` fault's short code ("0500_000E") drops the part and level
  1189. # groups and is not a code anyone can look up; its full code in the
  1190. # printer screen's four groups is (#2728).
  1191. full_code = str(err.get("full_code") or "")
  1192. label = "-".join(full_code[i : i + 4] for i in range(0, 16, 4)) if len(full_code) == 16 else short_code
  1193. parts.append(f"[{label}] {description}" if description else f"[{label}]")
  1194. return "; ".join(parts) if parts else None
  1195. async def _bump_library_file_usage_if_completed(db, item, queue_status: str) -> None:
  1196. """Increment LibraryFile.print_count and stamp last_printed_at when a queued
  1197. print completes successfully. Gated to status=='completed': failed, cancelled
  1198. and aborted prints do not count as usage. Caller is responsible for committing
  1199. the session. No-op when the queue item has no linked library file (e.g. reprints
  1200. from an archive). See #1008."""
  1201. if queue_status != "completed" or item.library_file_id is None:
  1202. return
  1203. from backend.app.models.library import LibraryFile
  1204. lib_file = await db.scalar(select(LibraryFile).where(LibraryFile.id == item.library_file_id))
  1205. if lib_file is None:
  1206. return
  1207. lib_file.print_count = (lib_file.print_count or 0) + 1
  1208. lib_file.last_printed_at = datetime.now(timezone.utc)
  1209. def mark_printer_stopped_by_user(printer_id: int) -> None:
  1210. """Mark that the active print on this printer was stopped by the user from the queue UI.
  1211. When on_print_complete fires with status 'failed' for a printer in this set we
  1212. reclassify it as 'cancelled' so the correct 'print stopped' notification is sent
  1213. rather than a 'print failed' notification.
  1214. """
  1215. _user_stopped_printers.add(printer_id)
  1216. logging.getLogger(__name__).info("Marked printer %s as user-stopped from queue", printer_id)
  1217. _last_status_broadcast: dict[int, str] = {}
  1218. # Track printers where we've updated nozzle_count
  1219. _nozzle_count_updated: set[int] = set()
  1220. async def _maybe_notify_printer_offline(printer_id: int) -> None:
  1221. """Wait the debounce window then fire `on_printer_offline` if the printer
  1222. is still offline.
  1223. Scheduled by `on_printer_status_change` on the connected → disconnected
  1224. edge (#1752). Cancelled by the same handler if the printer reconnects
  1225. before the window elapses, so a single MQTT blip + recovery doesn't
  1226. notify. Both the staleness-detector path (`bambu_mqtt.py::check_staleness`)
  1227. and the smart-plug power-off path (`printer_manager.mark_printer_offline`)
  1228. route through the same status-change callback, so this covers both.
  1229. """
  1230. logger = logging.getLogger(__name__)
  1231. try:
  1232. await asyncio.sleep(_PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS)
  1233. still_offline = not printer_manager.is_connected(printer_id)
  1234. logger.info(
  1235. "[#1752] Printer %s offline debounce elapsed: still_offline=%s",
  1236. printer_id,
  1237. still_offline,
  1238. )
  1239. if not still_offline:
  1240. return
  1241. async with async_session() as db:
  1242. from backend.app.models.printer import Printer
  1243. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1244. printer = result.scalar_one_or_none()
  1245. if not printer:
  1246. logger.warning(
  1247. "[#1752] Printer %s missing from DB at offline-notify time; skipping",
  1248. printer_id,
  1249. )
  1250. return
  1251. logger.info(
  1252. "[#1752] Dispatching on_printer_offline for printer %s (%s)",
  1253. printer_id,
  1254. printer.name,
  1255. )
  1256. await notification_service.on_printer_offline(printer_id, printer.name, db)
  1257. except asyncio.CancelledError:
  1258. raise
  1259. except Exception as e:
  1260. logger.warning("Printer offline notification failed for printer %s: %s", printer_id, e)
  1261. finally:
  1262. _printer_offline_notify_tasks.pop(printer_id, None)
  1263. def _hms_notify_key(error) -> str:
  1264. """What identifies a fault for notification de-duplication.
  1265. The full code, which is unique per fault. ``attr`` alone used to be the key:
  1266. unique for a ``print_error``, but for an ``hms[]`` fault it is only the
  1267. module and part, so two faults on one part (#1840's H2C held 0500-0600-0002-0005
  1268. and -0006 together) shared a key and only the first was ever notified. An
  1269. entry without a full code falls back to attr and code together.
  1270. """
  1271. full_code = getattr(error, "full_code", "") or ""
  1272. if full_code:
  1273. return full_code.upper()
  1274. return f"{error.attr:08X}:{error.code}"
  1275. def _hms_fault_counts(error) -> bool:
  1276. """Whether a fault counts as a problem: the same rule the frontend's
  1277. ``filterKnownHMSErrors`` applies to the printer card, badge and camera wall.
  1278. It counts when Bambu publishes text for it or it offers action buttons, and
  1279. its level is a real one. An ``hms[]`` fault at level 3 (notification) with
  1280. no actions does not count: those are things like "the top cover is open" or
  1281. "the chamber is hot, fan speed increased", which a printer can hold through
  1282. a whole print. A ``print_error`` at the same level (0xCxxx) still counts, as
  1283. it always has; those are prompts such as "unable to start drying" (#2728).
  1284. """
  1285. if error.severity < 1:
  1286. return False
  1287. has_actions = bool(getattr(error, "actions", None))
  1288. is_hms_notice = len(getattr(error, "full_code", "") or "") == 16 and error.severity == 3
  1289. return has_actions or (bool(getattr(error, "description", None)) and not is_hms_notice)
  1290. def _hms_errors_to_notify(errors: list, new_error_codes: set[str]) -> list:
  1291. """The new faults that count (see ``_hms_fault_counts``).
  1292. These go to the MQTT relay; the caller also needs a description before it
  1293. sends a notification. Level 0, Bambu's "invalid" level, never counts. This
  1294. used to read ``severity >= 2`` when severity held the part byte; on the real
  1295. level that would drop the task-stopping errors (#2728).
  1296. """
  1297. return [e for e in errors if _hms_notify_key(e) in new_error_codes and _hms_fault_counts(e)]
  1298. def _take_new_hms_faults(printer_id: int, errors: list) -> list:
  1299. """The faults on this printer not notified yet, and record them as notified.
  1300. Tracking is updated before anything is sent, so concurrent status callbacks
  1301. cannot notify the same fault twice. The set is replaced, not extended: a
  1302. fault that clears and later returns is notified again, and the grace period
  1303. in the caller keeps a fault that flickers off for a moment from doing that.
  1304. """
  1305. current = {_hms_notify_key(e) for e in errors}
  1306. new = current - _notified_hms_errors.get(printer_id, set())
  1307. _notified_hms_errors[printer_id] = current
  1308. _hms_last_seen[printer_id] = time.time()
  1309. return _hms_errors_to_notify(errors, new)
  1310. async def on_printer_status_change(printer_id: int, state: PrinterState):
  1311. """Handle printer status changes - broadcast via WebSocket."""
  1312. # Connected-edge reconciliation (#1542 follow-up). When the printer
  1313. # transitions disconnected → connected — which covers both Bambuddy
  1314. # startup (no prior connection) and a mid-session MQTT reconnect — fire
  1315. # `reconcile_stale_active_prints` exactly once for this connection so
  1316. # any archive still in `status="printing"` that can't actually be
  1317. # running anymore (printer IDLE / different subtask / empty subtask)
  1318. # gets a synthesised PRINT COMPLETE. Without this, a print that
  1319. # finished during a disconnect window + a smart-plug power cycle
  1320. # leaves the .3mf on the SD card and the firmware ghost-replays it on
  1321. # next boot. Reconciliation runs concurrently — it must not block the
  1322. # WebSocket dedup / broadcast logic below, and the connected edge is
  1323. # marked True BEFORE the await so concurrent status updates inside
  1324. # the same connection don't re-trigger reconciliation.
  1325. #
  1326. # Wait for a real push_status before reconciling (#1679): MQTT
  1327. # `_on_connect` broadcasts `state` IMMEDIATELY after the broker accepts
  1328. # the connection, BEFORE `_request_push_all` round-trips. At that
  1329. # instant the `PrinterState` is still on construction defaults — most
  1330. # importantly `state.state == "unknown"` and `state.subtask_name == ""`.
  1331. # If reconcile spawns here, every in-flight archive falls through to
  1332. # the empty-subtask_name trigger and gets synthesised `aborted`, which
  1333. # creates a duplicate archive on the real PRINT COMPLETE and
  1334. # double-counts filament. Gating on `state.state ∉ ("", "unknown")`
  1335. # keeps the #1542 mechanism intact: once the first real push_status
  1336. # updates `state.state` (RUNNING / IDLE / FINISH / …), this handler
  1337. # fires again with the flag still False — reconcile then runs against
  1338. # actual evidence.
  1339. state_known = bool(state.state) and state.state.upper() not in ("", "UNKNOWN")
  1340. if state.connected and state_known and not _printer_reconciled_since_connect.get(printer_id, False):
  1341. _printer_reconciled_since_connect[printer_id] = True
  1342. spawn_background_task(
  1343. reconcile_stale_active_prints(printer_id),
  1344. name=f"reconcile-stale-prints-{printer_id}",
  1345. )
  1346. elif not state.connected and _printer_reconciled_since_connect.get(printer_id, False):
  1347. # Re-arm so the next reconnect triggers reconciliation again.
  1348. _printer_reconciled_since_connect[printer_id] = False
  1349. # Same edge, for the calibration table the AMS card reads its K values from.
  1350. #
  1351. # Also gated on knowing a nozzle diameter, which is what decides *which*
  1352. # tables to ask for. A `state_known` gate alone is not enough: the first
  1353. # real push_status is what makes the state known, and the nozzle fields do
  1354. # not always arrive in it. Latching there would spend this connection's one
  1355. # attempt on a printer that could not yet say what was fitted.
  1356. nozzle_known = any(n.nozzle_diameter for n in (state.nozzles or []))
  1357. if (
  1358. state.connected
  1359. and state_known
  1360. and nozzle_known
  1361. and not _printer_kprofiles_primed_since_connect.get(printer_id, False)
  1362. ):
  1363. _printer_kprofiles_primed_since_connect[printer_id] = True
  1364. spawn_background_task(
  1365. prime_kprofile_table(printer_id),
  1366. name=f"prime-kprofiles-{printer_id}",
  1367. )
  1368. elif not state.connected and _printer_kprofiles_primed_since_connect.get(printer_id, False):
  1369. _printer_kprofiles_primed_since_connect[printer_id] = False
  1370. # Offline-notification edge (#1752): schedule `on_printer_offline` on
  1371. # connected → disconnected. The "back online" channel is already covered
  1372. # by the print-failure notification (firmware reports gcode_state=FAILED
  1373. # on reconnect of an interrupted print), so we don't add a symmetric
  1374. # online event here.
  1375. prev_connected = _printer_last_connected.get(printer_id)
  1376. _printer_last_connected[printer_id] = state.connected
  1377. if prev_connected is True and not state.connected:
  1378. existing = _printer_offline_notify_tasks.get(printer_id)
  1379. if existing is None or existing.done():
  1380. logging.getLogger(__name__).info(
  1381. "[#1752] Printer %s connected→disconnected edge; scheduling offline notification in %.0fs",
  1382. printer_id,
  1383. _PRINTER_OFFLINE_NOTIFY_DEBOUNCE_SECONDS,
  1384. )
  1385. _printer_offline_notify_tasks[printer_id] = asyncio.create_task(
  1386. _maybe_notify_printer_offline(printer_id),
  1387. name=f"printer-offline-notify-{printer_id}",
  1388. )
  1389. elif state.connected:
  1390. pending = _printer_offline_notify_tasks.pop(printer_id, None)
  1391. if pending is not None and not pending.done():
  1392. logging.getLogger(__name__).info(
  1393. "[#1752] Printer %s reconnected before debounce; cancelling pending offline notification",
  1394. printer_id,
  1395. )
  1396. pending.cancel()
  1397. # Only broadcast if something meaningful changed (reduce WebSocket spam)
  1398. # Include rounded temperatures to detect meaningful temp changes (within 1 degree)
  1399. temps = state.temperatures or {}
  1400. nozzle_temp = round(temps.get("nozzle", 0))
  1401. bed_temp = round(temps.get("bed", 0))
  1402. nozzle_2_temp = round(temps.get("nozzle_2", 0)) if "nozzle_2" in temps else ""
  1403. chamber_temp = round(temps.get("chamber", 0)) if "chamber" in temps else ""
  1404. # Auto-detect dual-nozzle printers from MQTT temperature data
  1405. if "nozzle_2" in temps and printer_id not in _nozzle_count_updated:
  1406. _nozzle_count_updated.add(printer_id)
  1407. # Update nozzle_count in database
  1408. async with async_session() as db:
  1409. from backend.app.models.printer import Printer
  1410. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1411. printer = result.scalar_one_or_none()
  1412. if printer and printer.nozzle_count != 2:
  1413. printer.nozzle_count = 2
  1414. await db.commit()
  1415. logging.getLogger(__name__).info(
  1416. f"Auto-detected dual-nozzle printer {printer_id}, updated nozzle_count=2"
  1417. )
  1418. # Include target temps for heating phase detection
  1419. bed_target = round(temps.get("bed_target", 0))
  1420. nozzle_target = round(temps.get("nozzle_target", 0))
  1421. # Include tray_now and vt_tray hash so external spool changes trigger broadcasts
  1422. vt_tray_key = hash(str(state.raw_data.get("vt_tray", []))) if state.raw_data else 0
  1423. # Include AMS dry_time and tray state values so drying/slot changes trigger broadcasts.
  1424. #
  1425. # dry_countdown_stalled rides along because it is the one drying signal the
  1426. # countdown itself cannot carry: the MQTT layer raises it precisely BECAUSE
  1427. # dry_time stopped moving, so on the frame that flips it every other member
  1428. # of this key is identical and the push would be deduplicated away. Mid-print
  1429. # a temperature would eventually break the tie, but a parked command on an
  1430. # idle machine changes nothing else at all — AMS temp and humidity are not in
  1431. # the key — so the badge could sit unreachable indefinitely. The flag flips at
  1432. # most once per drying cycle, so it costs no mid-print broadcast traffic.
  1433. ams_dry_key = (
  1434. tuple((a.get("dry_time", 0), bool(a.get("dry_countdown_stalled"))) for a in (state.raw_data.get("ams") or []))
  1435. if state.raw_data
  1436. else ()
  1437. )
  1438. # Include tray states so load/unload transitions (state 11→10) trigger broadcasts (#784)
  1439. #
  1440. # The filament identity fields are here because Configure Slot writes
  1441. # exactly those and nothing else. Re-configuring a slot from PLA to another
  1442. # brand or colour of PLA leaves id/tray_type/state identical, so the key
  1443. # matched, this function returned before broadcasting, and the card kept
  1444. # showing the old filament until the 30s fallback poll or a page reload —
  1445. # even though the configure route asks the printer for a fresh pushall and
  1446. # that push does carry the new values. Reset always worked, because it
  1447. # clears tray_type.
  1448. #
  1449. # These fields only change when someone configures a slot or swaps a spool,
  1450. # so unlike temperature or progress they add no broadcast traffic mid-print.
  1451. ams_tray_key = (
  1452. tuple(
  1453. (
  1454. t.get("id"),
  1455. t.get("tray_type", ""),
  1456. t.get("state"),
  1457. t.get("tray_color", ""),
  1458. t.get("tray_info_idx", ""),
  1459. t.get("tray_sub_brands", ""),
  1460. t.get("cali_idx"),
  1461. )
  1462. for a in (state.raw_data.get("ams") or [])
  1463. for t in a.get("tray", [])
  1464. )
  1465. if state.raw_data
  1466. else ()
  1467. )
  1468. # Filament Track Switch: which inlet each AMS is bound to, and whether the
  1469. # accessory is fitted at all. Neither is in ams_tray_key (it is per-tray) nor
  1470. # in the AMS change-hash (tray fields only, and widening that would fire
  1471. # spurious Spoolman syncs), so without them a "Join IN-B" on the printer
  1472. # screen changed no key at all and the card's inlet badges sat stale until a
  1473. # reload. Like the filament-backup flag, these only move when someone
  1474. # reconfigures the machine, so they add no mid-print broadcast traffic.
  1475. fts_key = (
  1476. state.fila_switch.installed if state.fila_switch else False,
  1477. tuple(sorted(state.ams_switch_inlet.items())),
  1478. # Which hotend holds which slot. Unlike the two above this does move
  1479. # mid-print, on every filament change — but only between discrete slots,
  1480. # so it adds a push per toolchange, not a stream. The AMS slot menu needs
  1481. # it live: it decides which hotend the Load dialog may offer and whether
  1482. # Unload has anything to act on.
  1483. tuple(
  1484. sorted(
  1485. ((ext, slot.ams_id, slot.slot_id, slot.has_filament) for ext, slot in state.extruder_slots.items()),
  1486. # Sort on the extruder id alone: the other members are nullable
  1487. # and comparing None with an int raises.
  1488. key=lambda entry: entry[0],
  1489. )
  1490. ),
  1491. )
  1492. status_key = (
  1493. f"{state.connected}:{state.state}:{state.progress}:{state.layer_num}:"
  1494. f"{nozzle_temp}:{bed_temp}:{nozzle_2_temp}:{chamber_temp}:"
  1495. f"{state.stg_cur}:{bed_target}:{nozzle_target}:"
  1496. f"{state.cooling_fan_speed}:{state.big_fan1_speed}:{state.big_fan2_speed}:"
  1497. f"{state.chamber_light}:{state.active_extruder}:{state.tray_now}:{vt_tray_key}:"
  1498. f"{ams_dry_key}:{ams_tray_key}:{state.door_open}:{state.ams_filament_backup}:{fts_key}"
  1499. )
  1500. is_active_print = state.state in _ACTIVE_PRINT_STATES
  1501. if not is_active_print:
  1502. _unauthorized_print_kill_sent.discard(printer_id)
  1503. elif printer_id in _unauthorized_print_kill_sent:
  1504. # stop_print() was already sent for this print; avoid all further
  1505. # ownership and settings work until the printer leaves an active state.
  1506. pass
  1507. elif _is_bambuddy_authorized_print_in_memory(printer_id, state):
  1508. # Normal Bambuddy-started prints stay entirely on the in-memory path.
  1509. _unauthorized_print_kill_sent.discard(printer_id)
  1510. else:
  1511. kill_switch_enabled = False
  1512. authorization: bool | None = None
  1513. status_logger = logging.getLogger(__name__)
  1514. try:
  1515. kill_switch_enabled = await _is_printer_kill_switch_enabled_cached()
  1516. if kill_switch_enabled:
  1517. async with async_session() as db:
  1518. authorization = await _is_bambuddy_authorized_print(printer_id, state, db)
  1519. except Exception as e:
  1520. # Fail safe: a database/reconciliation error must never turn into an
  1521. # irreversible stop of a print whose ownership is still unknown.
  1522. authorization = None
  1523. status_logger.warning(
  1524. "[KILL SWITCH] Failed to reconcile print authorization for printer %s: %s", printer_id, e
  1525. )
  1526. if not kill_switch_enabled or authorization is True:
  1527. _unauthorized_print_kill_sent.discard(printer_id)
  1528. elif authorization is None:
  1529. _unauthorized_print_kill_sent.discard(printer_id)
  1530. status_logger.debug(
  1531. "[KILL SWITCH] Deferring authorization for printer %s until archive state is reconciled",
  1532. printer_id,
  1533. )
  1534. else:
  1535. try:
  1536. stopped = printer_manager.stop_print(printer_id)
  1537. if stopped:
  1538. _unauthorized_print_kill_sent.add(printer_id)
  1539. printer_info = printer_manager.get_printer(printer_id)
  1540. printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
  1541. filename = state.subtask_name or state.gcode_file or state.current_print or "Unknown"
  1542. notification_data = {
  1543. "status": "stopped",
  1544. "filename": state.gcode_file or state.current_print or "",
  1545. "subtask_name": state.subtask_name or "",
  1546. "progress": state.progress,
  1547. "reason": "unauthorized_print",
  1548. }
  1549. status_logger.warning(
  1550. "[KILL SWITCH] Stopped unauthorized print on printer %s (state=%s)",
  1551. printer_id,
  1552. state.state,
  1553. )
  1554. try:
  1555. await ws_manager.broadcast(
  1556. {
  1557. "type": "kill_switch_triggered",
  1558. "printer_id": printer_id,
  1559. "printer_name": printer_name,
  1560. "filename": filename,
  1561. "reason": "unauthorized_print",
  1562. }
  1563. )
  1564. except Exception as e:
  1565. status_logger.warning(
  1566. "[KILL SWITCH] WebSocket notification failed for printer %s: %s", printer_id, e
  1567. )
  1568. previous_task = _kill_switch_notification_tasks.pop(printer_id, None)
  1569. if previous_task is not None and not previous_task.done():
  1570. previous_task.cancel()
  1571. _kill_switch_notification_tasks[printer_id] = spawn_background_task(
  1572. _send_kill_switch_provider_notification(printer_id, printer_name, notification_data),
  1573. name=f"kill-switch-notification-{printer_id}",
  1574. )
  1575. else:
  1576. status_logger.warning(
  1577. "[KILL SWITCH] Could not stop unauthorized print on printer %s (state=%s)",
  1578. printer_id,
  1579. state.state,
  1580. )
  1581. except Exception as e:
  1582. status_logger.warning(
  1583. "[KILL SWITCH] Failed to stop unauthorized print on printer %s: %s", printer_id, e
  1584. )
  1585. # MQTT relay - publish status (before dedup check - always publish to MQTT)
  1586. try:
  1587. printer_info = printer_manager.get_printer(printer_id)
  1588. if printer_info:
  1589. await mqtt_relay.on_printer_status(
  1590. printer_id,
  1591. state,
  1592. printer_info.name,
  1593. printer_info.serial_number,
  1594. printer_manager.is_awaiting_plate_clear(printer_id),
  1595. )
  1596. except Exception:
  1597. pass # Don't fail status callback if MQTT fails
  1598. if _last_status_broadcast.get(printer_id) == status_key:
  1599. return # No change, skip WebSocket broadcast
  1600. _last_status_broadcast[printer_id] = status_key
  1601. # Check for progress milestone notifications (25%, 50%, 75%)
  1602. progress = state.progress or 0
  1603. is_printing = state.state in ("RUNNING", "PRINTING")
  1604. if is_printing and progress > 0:
  1605. # Determine which milestone we've reached
  1606. current_milestone = 0
  1607. if progress >= 75:
  1608. current_milestone = 75
  1609. elif progress >= 50:
  1610. current_milestone = 50
  1611. elif progress >= 25:
  1612. current_milestone = 25
  1613. last_milestone = _last_progress_milestone.get(printer_id, 0)
  1614. # If we've crossed a new milestone, send notification
  1615. if current_milestone > last_milestone:
  1616. _last_progress_milestone[printer_id] = current_milestone
  1617. try:
  1618. from backend.app.models.printer import Printer
  1619. # Read the printer in a short session and release the connection
  1620. # BEFORE the ~15s camera snapshot below — holding it across the grab
  1621. # pinned a pooled connection per milestone, per printer (issue #2572).
  1622. async with async_session() as db:
  1623. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1624. printer = result.scalar_one_or_none()
  1625. printer_name = printer.name if printer else f"Printer {printer_id}"
  1626. filename = state.subtask_name or state.gcode_file or "Unknown"
  1627. # remaining_time is in minutes, convert to seconds for notification
  1628. remaining_time_seconds = state.remaining_time * 60 if state.remaining_time else None
  1629. # Capture camera snapshot for notification image attachment (no DB held).
  1630. image_data = await _capture_snapshot_for_notification(printer_id, printer, logging.getLogger(__name__))
  1631. # Notification send needs a session (provider/template lookups).
  1632. async with async_session() as db:
  1633. await notification_service.on_print_progress(
  1634. printer_id,
  1635. printer_name,
  1636. filename,
  1637. current_milestone,
  1638. db,
  1639. remaining_time_seconds,
  1640. image_data=image_data,
  1641. )
  1642. except Exception as e:
  1643. logging.getLogger(__name__).warning(f"Progress milestone notification failed: {e}")
  1644. elif progress < 5:
  1645. # Reset milestone tracking when print restarts or new print begins
  1646. _last_progress_milestone[printer_id] = 0
  1647. _first_layer_notified[printer_id] = False
  1648. # HMS error codes that should not trigger notifications even though they
  1649. # have known descriptions (e.g. user-initiated actions, not real errors).
  1650. _HMS_NOTIFICATION_SUPPRESS = {
  1651. "0500_400E", # Printing was cancelled (user action, not an error)
  1652. }
  1653. # Check for new HMS errors and send notifications
  1654. current_hms_errors = getattr(state, "hms_errors", []) or []
  1655. if current_hms_errors:
  1656. new_errors = _take_new_hms_faults(printer_id, current_hms_errors)
  1657. if new_errors:
  1658. try:
  1659. from backend.app.models.printer import Printer
  1660. # Read the printer in a short session and release the connection
  1661. # BEFORE the ~15s camera snapshot below (issue #2572).
  1662. async with async_session() as db:
  1663. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  1664. printer = result.scalar_one_or_none()
  1665. printer_name = printer.name if printer else f"Printer {printer_id}"
  1666. # Format error details for notification
  1667. # Module 0x07 = AMS/Filament, 0x05 = Nozzle, 0x0C = Motion Controller, etc.
  1668. module_names = {
  1669. 0x03: "Print/Task",
  1670. 0x05: "Nozzle/Extruder",
  1671. 0x07: "AMS/Filament",
  1672. 0x0C: "Motion Controller",
  1673. 0x12: "Chamber",
  1674. }
  1675. # Capture camera snapshot once for all error notifications (no DB held).
  1676. error_image_data = await _capture_snapshot_for_notification(
  1677. printer_id, printer, logging.getLogger(__name__)
  1678. )
  1679. # Notification sends need a session (provider/template lookups).
  1680. async with async_session() as db:
  1681. sent_count = 0
  1682. for error in new_errors:
  1683. module_name = module_names.get(error.module, f"Module 0x{error.module:02X}")
  1684. # Build short code like "0700_8010"
  1685. # Mask to 16 bits to handle printers that send larger values
  1686. error_code_int = int(error.code.replace("0x", ""), 16) if error.code else 0
  1687. error_code_masked = error_code_int & 0xFFFF
  1688. short_code = f"{(error.attr >> 16) & 0xFFFF:04X}_{error_code_masked:04X}"
  1689. # Only notify for errors Bambu publishes text for — printers
  1690. # send undocumented codes that aren't real errors, and Bambu
  1691. # lists some with empty text. Resolved at parse time (#2926);
  1692. # short_code is still needed for the suppression set below.
  1693. description = error.description
  1694. if not description or short_code in _HMS_NOTIFICATION_SUPPRESS:
  1695. continue
  1696. error_type = f"{module_name} Error"
  1697. error_detail = description
  1698. await notification_service.on_printer_error(
  1699. printer_id, printer_name, error_type, db, error_detail, image_data=error_image_data
  1700. )
  1701. sent_count += 1
  1702. if sent_count:
  1703. logging.getLogger(__name__).info(
  1704. f"[HMS] Sent notification for {sent_count} error(s) on printer {printer_id}"
  1705. )
  1706. # Also publish to MQTT relay (no DB): every new fault that
  1707. # counts, with or without text, the same set the UI counts.
  1708. printer_info = printer_manager.get_printer(printer_id)
  1709. if printer_info:
  1710. errors_data = [
  1711. {
  1712. "code": e.code,
  1713. "attr": e.attr,
  1714. "module": e.module,
  1715. "severity": e.severity,
  1716. }
  1717. for e in new_errors
  1718. ]
  1719. await mqtt_relay.on_printer_error(
  1720. printer_id, printer_info.name, printer_info.serial_number, errors_data
  1721. )
  1722. except Exception as e:
  1723. logging.getLogger(__name__).warning(f"HMS error notification failed: {e}")
  1724. else:
  1725. # No HMS errors — only clear tracking after a grace period to prevent
  1726. # flapping errors (brief hms:[] gaps) from re-triggering notifications.
  1727. # Some HMS codes (e.g. chamber temp regulation during PETG prints) toggle
  1728. # on/off every few seconds as conditions fluctuate around thresholds.
  1729. if printer_id in _notified_hms_errors:
  1730. last_seen = _hms_last_seen.get(printer_id, 0)
  1731. if time.time() - last_seen >= _HMS_CLEAR_GRACE_SECONDS:
  1732. _notified_hms_errors.pop(printer_id, None)
  1733. _hms_last_seen.pop(printer_id, None)
  1734. await ws_manager.send_printer_status(
  1735. printer_id,
  1736. printer_state_to_dict(
  1737. state,
  1738. printer_id,
  1739. printer_manager.get_model(printer_id),
  1740. printer_manager.get_drying_targets(printer_id),
  1741. ),
  1742. )
  1743. def _is_bambu_uuid(tray_uuid: str) -> bool:
  1744. """Check if a tray UUID looks like a valid Bambu Lab RFID UUID (non-empty, non-zero)."""
  1745. return bool(tray_uuid) and tray_uuid not in ("", "0" * len(tray_uuid))
  1746. async def on_fts_inlet_change(printer_id: int, ams_id: int, inlet: str):
  1747. """Re-point a moved AMS's K-profiles at the nozzle it now feeds.
  1748. K-profiles are per-nozzle and the printer's calibration table is numbered
  1749. per-nozzle, but a tray holds exactly one ``cali_idx``. Moving an AMS to the
  1750. switch's other inlet therefore silently invalidates every configured slot in
  1751. it: the index stays put and now resolves against the other nozzle's table.
  1752. Measured on the maintainer's H2C — one spool calibrated 0.018 on the left
  1753. and 0.020 on the right kept the left profile after the move, and a manual
  1754. RFID re-read only re-asserted the same wrong one.
  1755. Configuring a slot is a deliberate preparation step, so this re-selects
  1756. rather than re-configures: only the calibration binding moves, and only for
  1757. slots whose spool already has a stored profile for the new nozzle. A slot
  1758. Bambuddy knows nothing about is left exactly as the operator left it.
  1759. """
  1760. logger = logging.getLogger(__name__)
  1761. target_extruder = extruder_for_inlet(inlet)
  1762. if target_extruder is None:
  1763. return
  1764. client = printer_manager.get_client(printer_id)
  1765. state = printer_manager.get_status(printer_id)
  1766. if not client or not state or not state.raw_data:
  1767. return
  1768. # The nozzle the AMS now feeds -- the diameter of the TARGET extruder, not
  1769. # of nozzle 0. On a machine with two sizes fitted, moving the inlet changes
  1770. # the nozzle width, which changes both the K profile to select and the
  1771. # preset the slot should carry.
  1772. nozzle_diameter = nozzle_diameter_for_extruder(state, target_extruder, printer_manager.get_model(printer_id))
  1773. ams_raw = state.raw_data.get("ams")
  1774. ams_list = ams_raw.get("ams", []) if isinstance(ams_raw, dict) else ams_raw if isinstance(ams_raw, list) else []
  1775. unit = next((u for u in ams_list if str(u.get("id")) == str(ams_id)), None)
  1776. if not unit:
  1777. return
  1778. try:
  1779. async with async_session() as db:
  1780. for tray in unit.get("tray", []):
  1781. tray_id = int(tray.get("id", -1))
  1782. if tray_id < 0 or not tray.get("tray_type"):
  1783. continue
  1784. current_idx = tray.get("cali_idx")
  1785. profile = await find_slot_kprofile_for_extruder(
  1786. db,
  1787. printer_id,
  1788. ams_id,
  1789. tray_id,
  1790. target_extruder,
  1791. nozzle_diameter,
  1792. printer_manager.get_model(printer_id),
  1793. nozzle_flow_for_extruder(state, target_extruder, printer_manager.get_model(printer_id)),
  1794. )
  1795. if profile is None or profile.cali_idx is None:
  1796. continue
  1797. if current_idx == profile.cali_idx:
  1798. continue # Already on the right one.
  1799. logger.info(
  1800. "[Printer %s] AMS %s slot %s moved to inlet %s (nozzle %s): "
  1801. "re-selecting K-profile %s (cali_idx %s -> %s, K=%s)",
  1802. printer_id,
  1803. ams_id,
  1804. tray_id,
  1805. inlet,
  1806. target_extruder,
  1807. profile.name,
  1808. current_idx,
  1809. profile.cali_idx,
  1810. profile.k_value,
  1811. )
  1812. client.extrusion_cali_sel(
  1813. ams_id=ams_id,
  1814. tray_id=tray_id,
  1815. cali_idx=profile.cali_idx,
  1816. filament_id=printer_safe_filament_id(profile.filament_id, tray.get("tray_info_idx", "")),
  1817. nozzle_diameter=nozzle_diameter,
  1818. )
  1819. except Exception as e:
  1820. logger.warning("[Printer %s] Could not re-apply K-profiles after inlet move: %s", printer_id, e)
  1821. async def _unlink_stale_assignments(printer_id: int, ams_data: list, printing_now: bool) -> None:
  1822. """Unlink built-in inventory assignments whose slot no longer holds their spool.
  1823. Runs from ``on_ams_change`` and, for removals held by ``slot_unlink_grace``,
  1824. from the delayed re-check -- which is why it takes the AMS data and print
  1825. state as arguments instead of reading them from the push (#3186).
  1826. """
  1827. logger = logging.getLogger(__name__)
  1828. from backend.app.utils.color_utils import colors_similar as _colors_similar
  1829. # Auto-unlink spool assignments with stale fingerprints. Under the
  1830. # per-printer assignment lock since #3186: the held-removal re-check runs
  1831. # this outside any MQTT push, so it can now overlap one.
  1832. try:
  1833. async with _get_ams_assignment_lock(printer_id), async_session() as db:
  1834. from sqlalchemy.orm import selectinload
  1835. from backend.app.api.routes.inventory import _find_tray_in_ams_data
  1836. from backend.app.models.spool import Spool as _Spool
  1837. from backend.app.models.spool_assignment import SpoolAssignment as SA
  1838. from backend.app.services.ams_slot_presence import spool_present
  1839. from backend.app.services.inventory_mode import spoolman_owns_assignments
  1840. # Built-in assignments only. Since #2812 they survive a switch to
  1841. # Spoolman mode rather than being deleted by it, and this pass ends
  1842. # in ``db.delete`` — left ungated it would unlink them one slot at a
  1843. # time as the AMS contents changed under the other mode, undoing the
  1844. # preservation more slowly but just as completely.
  1845. assignments = []
  1846. if not await spoolman_owns_assignments(db):
  1847. result = await db.execute(
  1848. select(SA)
  1849. .where(SA.printer_id == printer_id)
  1850. .options(selectinload(SA.spool).selectinload(_Spool.k_profiles))
  1851. )
  1852. assignments = result.scalars().all()
  1853. # ``printing_now`` (top of this function) keeps a runout from
  1854. # unlinking the spool that fed the print — the next idle-time pass
  1855. # unlinks it if the user really did take it out.
  1856. stale = []
  1857. # Removals this pass is holding rather than unlinking (#3186).
  1858. held: set[tuple] = set()
  1859. for assignment in assignments:
  1860. # External spool assignments (ams_id=255) live in vt_tray, not AMS data
  1861. if assignment.ams_id == 255:
  1862. ps = printer_manager.get_status(printer_id)
  1863. vt_tray_raw = ps.raw_data.get("vt_tray", []) if ps else []
  1864. ext_id = assignment.tray_id + 254 # 0→254, 1→255
  1865. current_tray = None
  1866. for vt in vt_tray_raw:
  1867. if isinstance(vt, dict) and int(vt.get("id", 254)) == ext_id:
  1868. current_tray = vt
  1869. break
  1870. if not current_tray:
  1871. # vt_tray data may not have arrived yet — keep assignment
  1872. continue
  1873. else:
  1874. current_tray = _find_tray_in_ams_data(ams_data, assignment.ams_id, assignment.tray_id)
  1875. if not current_tray:
  1876. if printing_now:
  1877. logger.info(
  1878. "Auto-unlink skipped: spool %d AMS%d-T%d — slot empty during a running print (runout?)",
  1879. assignment.spool_id,
  1880. assignment.ams_id,
  1881. assignment.tray_id,
  1882. )
  1883. continue
  1884. # A whole AMS unit can drop out of one push and come back in
  1885. # the next; only a slot that stays gone is a removal (#3186).
  1886. hold_key = ("inventory", assignment.ams_id, assignment.tray_id, assignment.spool_id)
  1887. if not slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  1888. held.add(hold_key)
  1889. logger.info(
  1890. "Auto-unlink held: spool %d AMS%d-T%d — tray not found in AMS data; "
  1891. "unlinking if it is still gone in %ds",
  1892. assignment.spool_id,
  1893. assignment.ams_id,
  1894. assignment.tray_id,
  1895. int(slot_unlink_grace.GRACE_SECONDS),
  1896. )
  1897. continue
  1898. logger.info(
  1899. "Auto-unlink: spool %d AMS%d-T%d — tray not found in AMS data (slot empty?)",
  1900. assignment.spool_id,
  1901. assignment.ams_id,
  1902. assignment.tray_id,
  1903. )
  1904. stale.append(assignment) # Slot empty
  1905. elif _is_bambu_uuid(current_tray.get("tray_uuid", "")):
  1906. # A Bambu Lab spool is in this slot — check if it's the same spool
  1907. # that's currently assigned. If yes, keep the assignment (avoids
  1908. # unnecessary unlink/re-assign/ams_filament_setting cycle that clears
  1909. # the printer's filament preset on every startup).
  1910. tray_uuid = current_tray.get("tray_uuid", "")
  1911. tag_uid = current_tray.get("tag_uid", "")
  1912. spool = assignment.spool
  1913. spool_matches = False
  1914. if spool:
  1915. if (spool.tray_uuid and spool.tray_uuid.upper() == tray_uuid.upper()) or (
  1916. spool.tag_uid
  1917. and tag_uid
  1918. and tag_uid != "0000000000000000"
  1919. and spool.tag_uid.upper() == tag_uid.upper()
  1920. ):
  1921. spool_matches = True
  1922. if spool_matches:
  1923. # Same BL spool still in slot — keep assignment, update fingerprint if needed
  1924. cur_color = current_tray.get("tray_color", "")
  1925. cur_type = current_tray.get("tray_type", "")
  1926. fp_color = assignment.fingerprint_color or ""
  1927. fp_type = assignment.fingerprint_type or ""
  1928. if cur_color.upper() != fp_color.upper() or cur_type.upper() != fp_type.upper():
  1929. assignment.fingerprint_color = cur_color
  1930. assignment.fingerprint_type = cur_type
  1931. logger.debug(
  1932. "Auto-unlink: spool %d AMS%d-T%d — same BL spool, updated fingerprint",
  1933. assignment.spool_id,
  1934. assignment.ams_id,
  1935. assignment.tray_id,
  1936. )
  1937. continue
  1938. # Different BL spool or unrecognized — unlink so auto-assign can match
  1939. logger.info(
  1940. "Auto-unlink: spool %d AMS%d-T%d — different Bambu Lab spool detected (uuid=%s)",
  1941. assignment.spool_id,
  1942. assignment.ams_id,
  1943. assignment.tray_id,
  1944. tray_uuid,
  1945. )
  1946. stale.append(assignment)
  1947. else:
  1948. cur_color = current_tray.get("tray_color", "")
  1949. cur_type = current_tray.get("tray_type", "")
  1950. cur_state = current_tray.get("state")
  1951. fp_color = assignment.fingerprint_color or ""
  1952. fp_type = assignment.fingerprint_type or ""
  1953. # SpoolBuddy pre-config replay: fingerprint_type empty means
  1954. # the slot was empty when the user pre-assigned via SpoolBuddy
  1955. # (the firmware drops ams_filament_setting on empty slots, so
  1956. # MQTT was deferred). The moment any filament gets inserted
  1957. # — Bambu RFID, 3rd-party, or even an existing-but-now-
  1958. # reconfigured spool — fire the deferred configuration.
  1959. # The "loaded" signal is state == 11 (Bambu's "filament fed to
  1960. # extruder" code) OR, on firmwares that don't use the state
  1961. # enum meaningfully, a non-empty tray_type when state is
  1962. # NOT one of the firmware's explicit empty signals (9, 10).
  1963. # state-only was wrong for firmwares that never set 11 — A1
  1964. # Mini BMCU 01.07.02.00 and P1S Standard AMS 00.00.06.75 both
  1965. # always report state=3 — so the replay never fired for them
  1966. # (#1322). The state ∉ {9,10} guard keeps the firmware's
  1967. # explicit "empty" signals authoritative over any stale
  1968. # tray_type that might survive the relay's auto-clearing.
  1969. #
  1970. # tray_exist_bits comes first because that guard cannot tell
  1971. # a firmware "empty" from Bambuddy's own: apply_tray_exist_bits
  1972. # writes state=9 when the bit is 0 and leaves it there when the
  1973. # bit returns. A non-RFID spool inserted into a pre-assigned
  1974. # slot brings no tray_type with it, so the stale 9 made this
  1975. # expression false forever and the deferred config never fired
  1976. # — the deadlock #1322 removed from the assign path, still in
  1977. # place here (#3084, #3100).
  1978. loaded = spool_present(current_tray) is True or (
  1979. cur_state == 11 or (cur_state not in (9, 10) and cur_type.strip())
  1980. )
  1981. if not fp_type.strip() and loaded and assignment.spool:
  1982. try:
  1983. from backend.app.api.routes.inventory import (
  1984. apply_spool_to_slot_via_mqtt,
  1985. )
  1986. await apply_spool_to_slot_via_mqtt(
  1987. db=db,
  1988. current_user=None,
  1989. spool=assignment.spool,
  1990. printer_id=printer_id,
  1991. ams_id=assignment.ams_id,
  1992. tray_id=assignment.tray_id,
  1993. current_tray_info_idx=current_tray.get("tray_info_idx", ""),
  1994. current_tray_type=cur_type,
  1995. )
  1996. logger.info(
  1997. "SpoolBuddy pre-config applied on insert: spool %d → printer %d AMS%d-T%d",
  1998. assignment.spool_id,
  1999. printer_id,
  2000. assignment.ams_id,
  2001. assignment.tray_id,
  2002. )
  2003. except Exception:
  2004. logger.exception(
  2005. "Pre-config apply failed for spool %d on printer %d AMS%d-T%d",
  2006. assignment.spool_id,
  2007. printer_id,
  2008. assignment.ams_id,
  2009. assignment.tray_id,
  2010. )
  2011. assignment.fingerprint_color = cur_color
  2012. assignment.fingerprint_type = cur_type
  2013. continue
  2014. if not _colors_similar(cur_color, fp_color) or cur_type.upper() != fp_type.upper():
  2015. # Blank tray data mid-print is a runout, not a swap: the
  2016. # firmware clears colour and type when it unloads a spool
  2017. # it just emptied. Unlinking here would erase the record
  2018. # of which spool fed the print so far.
  2019. if printing_now and not cur_color.strip() and not cur_type.strip():
  2020. logger.info(
  2021. "Auto-unlink skipped: spool %d AMS%d-T%d — tray data cleared during a running print "
  2022. "(runout?)",
  2023. assignment.spool_id,
  2024. assignment.ams_id,
  2025. assignment.tray_id,
  2026. )
  2027. continue
  2028. # Same reasoning off the print, on firmware's own say-so:
  2029. # a blank tray report from a slot whose tray_exist_bits
  2030. # bit is set describes a spool the AMS cannot identify —
  2031. # a non-RFID one, or one whose slot was reset — not a
  2032. # spool that was taken out. Deleting the assignment there
  2033. # threw away the identity the user had supplied, which is
  2034. # the only place it existed (#3100). A slot the bit calls
  2035. # empty, or one that carries no bit at all, still unlinks.
  2036. #
  2037. # Unless the slot was reported empty first: a removal
  2038. # already held means a spool came out and another went
  2039. # in, so the blank report keeps the hold running below
  2040. # rather than cancelling it (#3186).
  2041. if (
  2042. spool_present(current_tray) is True
  2043. and not cur_color.strip()
  2044. and not cur_type.strip()
  2045. and not slot_unlink_grace.is_held(
  2046. printer_id,
  2047. ("inventory", assignment.ams_id, assignment.tray_id, assignment.spool_id),
  2048. )
  2049. ):
  2050. logger.info(
  2051. "Auto-unlink skipped: spool %d AMS%d-T%d — slot still occupied, "
  2052. "tray reports no filament data yet",
  2053. assignment.spool_id,
  2054. assignment.ams_id,
  2055. assignment.tray_id,
  2056. )
  2057. continue
  2058. # A blank report the presence bit does not vouch for is
  2059. # still only one push. An idle X1C cleared a whole AMS
  2060. # unit's bits, colour and type for a moment and lost
  2061. # four saved assignments that way (#3186); unlink only
  2062. # if the slot is still blank after the grace period.
  2063. if not cur_color.strip() and not cur_type.strip():
  2064. hold_key = ("inventory", assignment.ams_id, assignment.tray_id, assignment.spool_id)
  2065. if not slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2066. held.add(hold_key)
  2067. logger.info(
  2068. "Auto-unlink held: spool %d AMS%d-T%d — tray reports no filament data; "
  2069. "unlinking if it is still blank in %ds",
  2070. assignment.spool_id,
  2071. assignment.ams_id,
  2072. assignment.tray_id,
  2073. int(slot_unlink_grace.GRACE_SECONDS),
  2074. )
  2075. continue
  2076. # Fingerprint mismatch — but check if tray now matches the
  2077. # assigned spool (e.g. auto-configure changed the tray).
  2078. # Both sides are reduced to the type the slot can carry
  2079. # before comparing: the assign path writes that rather
  2080. # than the spool's raw material (#2902), so a spool whose
  2081. # material is a product line — "PLA+", "HTPLA" — reports
  2082. # back as "PLA" and would otherwise fail this check and
  2083. # be auto-unlinked from the slot it was just assigned to.
  2084. # Reducing the printer's side too keeps slots configured
  2085. # by an older Bambuddy, still reporting "PLA+", matching.
  2086. spool = assignment.spool
  2087. if spool:
  2088. spool_color = (spool.rgba or "FFFFFFFF").upper()
  2089. # Two ways the assign path can have arrived at the
  2090. # slot's type, so both count as "we wrote this".
  2091. # The material column is one; the spool's preset is
  2092. # the other, and it outranks the material when the
  2093. # spool has one -- a spool whose material says PLA
  2094. # and whose preset is "Bambu PLA Aero" puts
  2095. # PLA-AERO in the slot (#2902). Read from the stored
  2096. # preset name rather than resolving the preset,
  2097. # because this runs on every AMS push and a cloud
  2098. # lookup here would be both slow and unavailable on
  2099. # the unauthenticated replay path.
  2100. spool_types = {printer_filament_type(spool.material).upper()}
  2101. if spool.slicer_filament_name:
  2102. spool_types.add(printer_filament_type(spool.slicer_filament_name).upper())
  2103. # An imported local preset stores its type outright,
  2104. # which is what the assign path used -- and the name
  2105. # above may be unset. One keyed read, and only on a
  2106. # mismatch, which is rare.
  2107. #
  2108. # slicer_filament is free text up to fifty characters,
  2109. # so the digits have to be checked against the range
  2110. # of the integer primary key they are about to be
  2111. # compared with. Postgres raises on an out-of-range
  2112. # integer rather than simply not matching, and that
  2113. # would poison this session and abandon the rest of
  2114. # the cleanup pass.
  2115. lp_ref = (spool.slicer_filament or "").strip()
  2116. if lp_ref.isdigit() and int(lp_ref) <= 2147483647:
  2117. from backend.app.models.local_preset import LocalPreset as _LP
  2118. lp_type = await db.scalar(select(_LP.filament_type).where(_LP.id == int(lp_ref)))
  2119. if lp_type:
  2120. spool_types.add(printer_filament_type(lp_type).upper())
  2121. if (
  2122. _colors_similar(cur_color, spool_color)
  2123. and printer_filament_type(cur_type).upper() in spool_types
  2124. ):
  2125. logger.info(
  2126. "Auto-unlink: spool %d AMS%d-T%d — fingerprint mismatch but tray matches spool, updating fp",
  2127. assignment.spool_id,
  2128. assignment.ams_id,
  2129. assignment.tray_id,
  2130. )
  2131. assignment.fingerprint_color = cur_color
  2132. assignment.fingerprint_type = cur_type
  2133. continue
  2134. logger.info(
  2135. "Auto-unlink: spool %d AMS%d-T%d — fingerprint mismatch (cur=%s/%s fp=%s/%s spool=%s/%s)",
  2136. assignment.spool_id,
  2137. assignment.ams_id,
  2138. assignment.tray_id,
  2139. cur_color,
  2140. cur_type,
  2141. fp_color,
  2142. fp_type,
  2143. spool.rgba if spool else "?",
  2144. spool.material if spool else "?",
  2145. )
  2146. stale.append(assignment) # Spool changed
  2147. slot_unlink_grace.settle(printer_id, "inventory", held)
  2148. # Snapshot slots before delete — ORM attribute access after the
  2149. # commit would refresh against a deleted row.
  2150. unlinked_slots = [(a.ams_id, a.tray_id) for a in stale]
  2151. for a in stale:
  2152. await db.delete(a)
  2153. if stale:
  2154. logger.info("Auto-unlinked %d stale spool assignments for printer %d", len(stale), printer_id)
  2155. # Commit any changes (stale deletions and/or fingerprint updates)
  2156. await db.commit()
  2157. # Tell open browsers the assignment is gone (#2575). Only the manual
  2158. # REST assign/unassign endpoints broadcast this event; without it the
  2159. # frontend's spool-assignments cache keeps rendering the unlinked
  2160. # spool on the slot until an unrelated refetch — which reads exactly
  2161. # like "the fix didn't work" (reporter verified: a browser refresh
  2162. # after the swap showed the correct state all along).
  2163. for ams_id, tray_id in unlinked_slots:
  2164. await ws_manager.broadcast(
  2165. {
  2166. "type": "spool_assignment_changed",
  2167. "printer_id": printer_id,
  2168. "ams_id": ams_id,
  2169. "tray_id": tray_id,
  2170. }
  2171. )
  2172. except Exception as e:
  2173. logger.warning("Spool assignment cleanup failed: %s", e, exc_info=True)
  2174. async def _expire_spoolman_empty_slots(printer_id: int, ams_data: list, printing_now: bool) -> None:
  2175. """Delete Spoolman slot rows whose held removal has run its grace period.
  2176. The Spoolman half of the #3186 re-check. The full sync in ``on_ams_change``
  2177. talks to Spoolman for every tray; this only needs the local rows, so it
  2178. repeats that pass's empty-slot decision -- a tray with no type or no colour
  2179. (``parse_ams_tray`` returns None for exactly those), not during a print, and
  2180. not in a slot the presence bit calls occupied -- and nothing else.
  2181. """
  2182. logger = logging.getLogger(__name__)
  2183. try:
  2184. async with async_session() as db:
  2185. from backend.app.api.routes.settings import get_setting
  2186. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2187. from backend.app.services.ams_slot_presence import spool_present
  2188. enabled = await get_setting(db, "spoolman_enabled")
  2189. if not enabled or enabled.lower() != "true":
  2190. return
  2191. sync_mode = await get_setting(db, "spoolman_sync_mode")
  2192. if sync_mode and sync_mode != "auto":
  2193. return
  2194. trays: dict[tuple[int, int], dict] = {}
  2195. for ams_unit in ams_data or []:
  2196. if not isinstance(ams_unit, dict):
  2197. continue
  2198. for tray in ams_unit.get("tray", []):
  2199. if isinstance(tray, dict):
  2200. trays[(int(ams_unit.get("id", 0)), int(tray.get("id", 0)))] = tray
  2201. rows = (
  2202. (
  2203. await db.execute(
  2204. select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer_id)
  2205. )
  2206. )
  2207. .scalars()
  2208. .all()
  2209. )
  2210. held: set[tuple] = set()
  2211. expired: list[tuple[int, int]] = []
  2212. for row in rows:
  2213. tray = trays.get((row.ams_id, row.tray_id))
  2214. if tray is None or printing_now:
  2215. continue
  2216. if (tray.get("tray_type") or "").strip() and (tray.get("tray_color") or "").strip():
  2217. continue
  2218. hold_key = ("spoolman", row.ams_id, row.tray_id, row.spoolman_spool_id)
  2219. if spool_present(tray) is True and not slot_unlink_grace.is_held(printer_id, hold_key):
  2220. continue
  2221. if slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2222. expired.append((row.ams_id, row.tray_id))
  2223. else:
  2224. held.add(hold_key)
  2225. slot_unlink_grace.settle(printer_id, "spoolman", held)
  2226. if not expired:
  2227. return
  2228. # A statement rather than ORM deletes, like the sync pass: the two
  2229. # can overlap, and a row the other already removed must not fail
  2230. # this commit.
  2231. for ams_id, tray_id in expired:
  2232. await db.execute(
  2233. delete(SpoolmanSlotAssignment).where(
  2234. SpoolmanSlotAssignment.printer_id == printer_id,
  2235. SpoolmanSlotAssignment.ams_id == ams_id,
  2236. SpoolmanSlotAssignment.tray_id == tray_id,
  2237. )
  2238. )
  2239. await db.commit()
  2240. logger.info("Unlinked %d Spoolman slot(s) that stayed empty for printer %d", len(expired), printer_id)
  2241. for ams_id, tray_id in expired:
  2242. await ws_manager.broadcast(
  2243. {
  2244. "type": "spool_assignment_changed",
  2245. "printer_id": printer_id,
  2246. "ams_id": ams_id,
  2247. "tray_id": tray_id,
  2248. }
  2249. )
  2250. except Exception as e:
  2251. logger.warning("Spoolman slot re-check failed for printer %s: %s", printer_id, e, exc_info=True)
  2252. async def _recheck_held_unlinks(printer_id: int) -> None:
  2253. """Re-run just the slot cleanup against the printer's current AMS state.
  2254. Scheduled by ``slot_unlink_grace`` when it holds a removal. The unlink
  2255. passes otherwise run only when the AMS hash changes, and a slot that went
  2256. empty and stayed empty may never change it again.
  2257. """
  2258. status = printer_manager.get_status(printer_id)
  2259. # A disconnected printer's state is its last report, not a new one: acting
  2260. # on it would "confirm" a removal nobody has seen for the whole grace
  2261. # period. Leave the holds; the first push after reconnecting decides.
  2262. if status is None or not status.connected:
  2263. return
  2264. ams_raw = status.raw_data.get("ams")
  2265. ams_data = ams_raw.get("ams", []) if isinstance(ams_raw, dict) else ams_raw if isinstance(ams_raw, list) else []
  2266. printing_now = (getattr(status, "state", "") or "").upper() in ("RUNNING", "PAUSE")
  2267. await _unlink_stale_assignments(printer_id, ams_data, printing_now)
  2268. await _expire_spoolman_empty_slots(printer_id, ams_data, printing_now)
  2269. slot_unlink_grace.set_recheck(_recheck_held_unlinks)
  2270. async def on_ams_change(printer_id: int, ams_data: list):
  2271. """Handle AMS data changes - sync to Spoolman if enabled and auto mode."""
  2272. logger = logging.getLogger(__name__)
  2273. # Snapshot BEFORE any await: if a print is active, skip weight sync later.
  2274. # on_print_complete may pop _active_sessions during our awaits (#880).
  2275. from backend.app.services.usage_tracker import _active_sessions
  2276. _print_active = printer_id in _active_sessions
  2277. # A slot that reports empty while a print is running is a filament runout,
  2278. # not a spool swap: the spool is still physically in the AMS, just
  2279. # consumed. Dropping either inventory backend's slot link there loses the
  2280. # only record of which spool fed the print, so the completion path can't
  2281. # charge the runout segment to anything. Both cleanup passes below consult
  2282. # this; computed once, up front, so neither depends on the other having run.
  2283. _unlink_state = printer_manager.get_status(printer_id)
  2284. printing_now = (getattr(_unlink_state, "state", "") or "").upper() in ("RUNNING", "PAUSE")
  2285. # MQTT relay - publish AMS change
  2286. try:
  2287. printer_info = printer_manager.get_printer(printer_id)
  2288. if printer_info:
  2289. await mqtt_relay.on_ams_change(printer_id, printer_info.name, printer_info.serial_number, ams_data)
  2290. except Exception:
  2291. pass # Don't fail AMS callback if MQTT fails
  2292. # Broadcast AMS change via WebSocket (bypasses status_key deduplication)
  2293. # This ensures frontend gets immediate updates when AMS slots are configured
  2294. try:
  2295. state = printer_manager.get_status(printer_id)
  2296. if state:
  2297. logger.info("[Printer %s] Broadcasting AMS change via WebSocket", printer_id)
  2298. await ws_manager.send_printer_status(
  2299. printer_id,
  2300. printer_state_to_dict(
  2301. state,
  2302. printer_id,
  2303. printer_manager.get_model(printer_id),
  2304. printer_manager.get_drying_targets(printer_id),
  2305. ),
  2306. )
  2307. except Exception as e:
  2308. logger.warning("Failed to broadcast AMS change for printer %s: %s", printer_id, e)
  2309. await _unlink_stale_assignments(printer_id, ams_data, printing_now)
  2310. # Auto-manage inventory spools from AMS tray data (skip if Spoolman manages AMS).
  2311. # Serialised per-printer via _ams_assignment_locks: MQTT bursts can deliver
  2312. # two AMS pushes ~30 ms apart, and without the lock both callbacks read
  2313. # "no existing assignment" for the same (printer, ams, tray) and race to
  2314. # INSERT, hitting the spool_assignment_printer_id_ams_id_tray_id_key
  2315. # unique constraint on Postgres. SQLite's WAL serialises writes so the
  2316. # bug stayed latent there. See _ams_assignment_locks comment for details.
  2317. try:
  2318. async with _get_ams_assignment_lock(printer_id), async_session() as db:
  2319. from sqlalchemy.orm import selectinload
  2320. from backend.app.api.routes.settings import get_setting
  2321. from backend.app.models.spool import Spool
  2322. from backend.app.models.spool_assignment import SpoolAssignment as SA
  2323. from backend.app.services.spool_tag_matcher import (
  2324. auto_assign_spool,
  2325. create_spool_from_tray,
  2326. find_matching_untagged_spool,
  2327. get_spool_by_tag,
  2328. is_bambu_tag,
  2329. is_valid_tag,
  2330. link_tag_to_inventory_spool,
  2331. )
  2332. _spoolman_on = await get_setting(db, "spoolman_enabled")
  2333. _auto_add_raw = await get_setting(db, "auto_add_unknown_rfid")
  2334. _auto_add_unknown = _auto_add_raw is None or _auto_add_raw.lower() == "true"
  2335. if not _spoolman_on or _spoolman_on.lower() != "true":
  2336. for ams_unit in ams_data:
  2337. if not isinstance(ams_unit, dict):
  2338. continue
  2339. ams_id = int(ams_unit.get("id", 0))
  2340. for tray in ams_unit.get("tray", []):
  2341. if not isinstance(tray, dict):
  2342. continue
  2343. tray_id = int(tray.get("id", 0))
  2344. tag_uid = tray.get("tag_uid", "")
  2345. tray_uuid = tray.get("tray_uuid", "")
  2346. tray_info_idx = tray.get("tray_info_idx", "")
  2347. if not tray.get("tray_type"):
  2348. # Slot reported empty — drop any cached unknown-tag
  2349. # broadcast so reinserting the same spool re-prompts.
  2350. _clear_unknown_tag_dedup(printer_id, ams_id, tray_id)
  2351. continue # Empty slot
  2352. # Check if assignment already exists for this slot
  2353. existing = await db.execute(
  2354. select(SA)
  2355. .options(selectinload(SA.spool).selectinload(Spool.k_profiles))
  2356. .where(SA.printer_id == printer_id, SA.ams_id == ams_id, SA.tray_id == tray_id)
  2357. )
  2358. existing_assignment = existing.scalar_one_or_none()
  2359. if existing_assignment:
  2360. # Sync spool weight_used from AMS remain — only INCREASE, never decrease.
  2361. # The AMS remain% is low-resolution (integer %, i.e. 10g steps for 1kg spool)
  2362. # and must not overwrite precise values from the usage tracker (3MF/G-code).
  2363. # Skip during active prints: the usage tracker handles deduction
  2364. # precisely via 3MF data on print completion. Without this guard the
  2365. # AMS remain% SET and the usage tracker ADD both fire from the same
  2366. # MQTT message, doubling the deduction (#880).
  2367. if _print_active:
  2368. continue
  2369. remain_raw = tray.get("remain")
  2370. if (
  2371. remain_raw is not None
  2372. and existing_assignment.spool
  2373. and not existing_assignment.spool.weight_locked
  2374. ):
  2375. try:
  2376. remain_val = int(remain_raw)
  2377. except (TypeError, ValueError):
  2378. remain_val = -1
  2379. if 1 <= remain_val <= 100:
  2380. lw = existing_assignment.spool.label_weight or 1000
  2381. new_used = round(lw * (100 - remain_val) / 100.0, 1)
  2382. current_used = existing_assignment.spool.weight_used or 0
  2383. if new_used > current_used + 1:
  2384. logger.info(
  2385. "Weight sync: spool %d weight_used %s -> %s (remain=%d)",
  2386. existing_assignment.spool_id,
  2387. current_used,
  2388. new_used,
  2389. remain_val,
  2390. )
  2391. existing_assignment.spool.weight_used = new_used
  2392. await db.commit()
  2393. # Re-apply stored K-profile when the live tray's
  2394. # cali_idx drifted from the spool's stored profile.
  2395. # This catches "reset slot → re-read" and any other
  2396. # path where the firmware loses the user's K-profile
  2397. # selection while the SpoolAssignment row persists.
  2398. # Per the maintainer's rule: any time a spool tag is
  2399. # identified and matches inventory, the slot must be
  2400. # configured with the spool's stored settings. Without
  2401. # this block the existing-assignment branch only ran
  2402. # weight-sync and let the firmware-default cali_idx win.
  2403. try:
  2404. spool = existing_assignment.spool
  2405. if (
  2406. spool is not None
  2407. and is_bambu_tag(tag_uid, tray_uuid, tray_info_idx)
  2408. and spool.k_profiles
  2409. ):
  2410. state = printer_manager.get_status(printer_id)
  2411. slot_nozzle = resolve_slot_nozzle(
  2412. state, ams_id, tray_id, printer_manager.get_model(printer_id)
  2413. )
  2414. nozzle_diameter = slot_nozzle.diameter
  2415. slot_extruder = slot_nozzle.extruder
  2416. # Prefer exact extruder match, fall back to
  2417. # extruder-agnostic kp for the same printer +
  2418. # nozzle. Avoids hard-skipping when the AMS is
  2419. # mapped differently than at calibration time.
  2420. matching_kp = None
  2421. fallback_kp = None
  2422. for kp in spool.k_profiles:
  2423. if (
  2424. kp.printer_id != printer_id
  2425. or kp.nozzle_diameter != nozzle_diameter
  2426. or kp.cali_idx is None
  2427. or not slot_nozzle.flow_matches(kp.nozzle_type)
  2428. ):
  2429. continue
  2430. if (
  2431. slot_extruder is not None
  2432. and kp.extruder is not None
  2433. and kp.extruder == slot_extruder
  2434. ):
  2435. matching_kp = kp
  2436. break
  2437. if fallback_kp is None:
  2438. fallback_kp = kp
  2439. chosen_kp = matching_kp or fallback_kp
  2440. if chosen_kp is not None:
  2441. live_cali_idx = tray.get("cali_idx")
  2442. # Only fire MQTT when the printer's live
  2443. # cali_idx differs from the stored value.
  2444. # Avoids spamming the broker on every
  2445. # MQTT push during steady-state operation.
  2446. if live_cali_idx != chosen_kp.cali_idx:
  2447. client = printer_manager.get_client(printer_id)
  2448. if client:
  2449. cali_filament_id = spool.slicer_filament or tray_info_idx or ""
  2450. client.extrusion_cali_sel(
  2451. ams_id=ams_id,
  2452. tray_id=tray_id,
  2453. cali_idx=chosen_kp.cali_idx,
  2454. filament_id=cali_filament_id,
  2455. nozzle_diameter=nozzle_diameter,
  2456. )
  2457. logger.info(
  2458. "Re-applied K-profile cali_idx=%d for spool %d "
  2459. "on printer %d AMS%d-T%d (live=%s drift detected)",
  2460. chosen_kp.cali_idx,
  2461. spool.id,
  2462. printer_id,
  2463. ams_id,
  2464. tray_id,
  2465. live_cali_idx,
  2466. )
  2467. except Exception:
  2468. logger.exception(
  2469. "K-profile re-apply failed for printer %d AMS%d-T%d",
  2470. printer_id,
  2471. ams_id,
  2472. tray_id,
  2473. )
  2474. continue
  2475. if is_bambu_tag(tag_uid, tray_uuid, tray_info_idx):
  2476. # BL spool with RFID tag: auto-match → inventory match → auto-create
  2477. spool = await get_spool_by_tag(db, tag_uid, tray_uuid)
  2478. if not spool:
  2479. # Try matching an untagged inventory spool (same material/color)
  2480. spool = await find_matching_untagged_spool(db, tray)
  2481. if spool:
  2482. await link_tag_to_inventory_spool(db, spool, tray)
  2483. elif _auto_add_unknown:
  2484. spool = await create_spool_from_tray(db, tray)
  2485. else:
  2486. # Auto-add disabled: surface the slot so the
  2487. # user can add it manually via the UI.
  2488. await _broadcast_unknown_tag(
  2489. printer_id=printer_id,
  2490. ams_id=ams_id,
  2491. tray_id=tray_id,
  2492. tag_uid=tag_uid,
  2493. tray_uuid=tray_uuid,
  2494. tray_type=tray.get("tray_type"),
  2495. tray_color=tray.get("tray_color"),
  2496. tray_sub_brands=tray.get("tray_sub_brands"),
  2497. tray_count=len(ams_unit.get("tray", [])),
  2498. )
  2499. continue
  2500. # Slot matched (existing tag, untagged inventory
  2501. # match, or freshly auto-created spool) — drop any
  2502. # stale dedup so a future tag swap re-prompts.
  2503. _clear_unknown_tag_dedup(printer_id, ams_id, tray_id)
  2504. await auto_assign_spool(
  2505. printer_id,
  2506. ams_id,
  2507. tray_id,
  2508. spool,
  2509. printer_manager,
  2510. db,
  2511. tray_info_idx=tray_info_idx,
  2512. )
  2513. await db.commit()
  2514. await ws_manager.broadcast(
  2515. {
  2516. "type": "spool_auto_assigned",
  2517. "printer_id": printer_id,
  2518. "ams_id": ams_id,
  2519. "tray_id": tray_id,
  2520. "spool_id": spool.id,
  2521. }
  2522. )
  2523. logger.info(
  2524. "RFID auto-assigned spool %d to printer %d AMS%d-T%d",
  2525. spool.id,
  2526. printer_id,
  2527. ams_id,
  2528. tray_id,
  2529. )
  2530. elif is_valid_tag(tag_uid, tray_uuid):
  2531. # Non-BL spool with some tag — let user choose
  2532. await _broadcast_unknown_tag(
  2533. printer_id=printer_id,
  2534. ams_id=ams_id,
  2535. tray_id=tray_id,
  2536. tag_uid=tag_uid,
  2537. tray_uuid=tray_uuid,
  2538. tray_type=tray.get("tray_type"),
  2539. tray_color=tray.get("tray_color"),
  2540. tray_sub_brands=tray.get("tray_sub_brands"),
  2541. tray_count=len(ams_unit.get("tray", [])),
  2542. )
  2543. # No-tag slots (generic non-RFID filament) are left alone:
  2544. # nothing to identify, prompting "+ Add" would just create
  2545. # ghost spools with empty tags on every confirm.
  2546. except Exception as e:
  2547. logger.warning("RFID spool auto-assign failed: %s", e, exc_info=True)
  2548. try:
  2549. async with async_session() as db:
  2550. from backend.app.api.routes.settings import get_setting
  2551. from backend.app.models.printer import Printer
  2552. # Check if Spoolman is enabled
  2553. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  2554. if not spoolman_enabled or spoolman_enabled.lower() != "true":
  2555. return
  2556. # Check sync mode
  2557. sync_mode = await get_setting(db, "spoolman_sync_mode")
  2558. if sync_mode and sync_mode != "auto":
  2559. return # Only sync on auto mode
  2560. _auto_add_raw_sm = await get_setting(db, "auto_add_unknown_rfid")
  2561. auto_add_unknown_rfid = _auto_add_raw_sm is None or _auto_add_raw_sm.lower() == "true"
  2562. # `spoolman_disable_weight_sync` is deprecated (#1119) — weight is now
  2563. # always owned by per-print tracking, never by AMS auto-sync. The
  2564. # setting is still read by the settings UI for backwards compat but
  2565. # has no effect on the sync path here.
  2566. # Get Spoolman URL
  2567. spoolman_url = await get_setting(db, "spoolman_url")
  2568. if not spoolman_url:
  2569. return
  2570. # Get or create Spoolman client
  2571. client = await get_spoolman_client()
  2572. if not client:
  2573. try:
  2574. client = await init_spoolman_client(spoolman_url)
  2575. except ValueError as exc:
  2576. logger.warning("Spoolman URL %r rejected by SSRF guard: %s", spoolman_url, exc)
  2577. return
  2578. # Check if Spoolman is reachable
  2579. if not await client.health_check():
  2580. logger.warning("Spoolman not reachable at %s", spoolman_url)
  2581. return
  2582. # Get printer name for location
  2583. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  2584. printer = result.scalar_one_or_none()
  2585. printer_name = printer.name if printer else f"Printer {printer_id}"
  2586. # OPTIMIZATION: Fetch all spools once before processing trays
  2587. # This eliminates redundant API calls (one per tray) when syncing multiple trays
  2588. logger.debug("[Printer %s] Fetching spools cache for AMS sync...", printer_id)
  2589. try:
  2590. cached_spools = await client.get_spools()
  2591. logger.debug("[Printer %s] Cached %d spools for batch sync", printer_id, len(cached_spools))
  2592. except Exception as e:
  2593. logger.error(
  2594. "[Printer %s] Failed to fetch spools cache after retries, aborting AMS sync: %s",
  2595. printer_id,
  2596. e,
  2597. )
  2598. return
  2599. # Load inventory weights as fallback (when AMS MQTT data lacks remain values)
  2600. from sqlalchemy.orm import selectinload
  2601. from backend.app.models.spool_assignment import SpoolAssignment
  2602. from backend.app.models.spoolman_slot_assignment import SpoolmanSlotAssignment
  2603. from backend.app.services.ams_slot_presence import spool_present
  2604. from backend.app.services.inventory_mode import spoolman_owns_assignments
  2605. # Built-in remaining weight, used by sync_ams_tray only when the
  2606. # firmware reports an unusable remain%/tray_weight for a slot.
  2607. #
  2608. # Left empty since #2812. This block runs in Spoolman mode only,
  2609. # and until then the built-in table was emptied on the switch, so
  2610. # there was never anything here to read and the fallback was inert.
  2611. # Preserving those rows makes it live again, and it is keyed by slot
  2612. # rather than by spool: after a mode switch the tray may well hold
  2613. # different filament, and ``create_spool`` writes ``remaining_weight``
  2614. # unconditionally, so a stale figure would be seeded into a brand new
  2615. # Spoolman spool. Deliberately kept inert rather than deleted, so the
  2616. # intent survives for whoever revisits the cross-mode fallback.
  2617. inventory_weights: dict[tuple[int, int], float] = {}
  2618. if not await spoolman_owns_assignments(db):
  2619. try:
  2620. assign_result = await db.execute(
  2621. select(SpoolAssignment)
  2622. .options(selectinload(SpoolAssignment.spool))
  2623. .where(SpoolAssignment.printer_id == printer_id)
  2624. )
  2625. for assignment in assign_result.scalars().all():
  2626. spool = assignment.spool
  2627. if spool and spool.label_weight > 0:
  2628. remaining = max(0.0, spool.label_weight - (spool.weight_used or 0))
  2629. inventory_weights[(assignment.ams_id, assignment.tray_id)] = remaining
  2630. except Exception as e:
  2631. logger.warning("Could not load inventory weights for printer %s: %s", printer_id, e)
  2632. # Load existing Spoolman slot assignments for the no-RFID fallback path
  2633. spoolman_slot_map: dict[tuple[int, int], int] = {}
  2634. try:
  2635. slot_result = await db.execute(
  2636. select(SpoolmanSlotAssignment).where(SpoolmanSlotAssignment.printer_id == printer_id)
  2637. )
  2638. for slot in slot_result.scalars().all():
  2639. spoolman_slot_map[(slot.ams_id, slot.tray_id)] = slot.spoolman_spool_id
  2640. except Exception as e:
  2641. logger.warning("Could not load Spoolman slot assignments for printer %s: %s", printer_id, e)
  2642. # Sync each AMS tray and collect slot changes for DB persistence
  2643. synced = 0
  2644. slot_changes: list[tuple[int, int, int]] = [] # (ams_id, tray_id, spoolman_spool_id) to upsert
  2645. empty_slots: list[tuple[int, int]] = [] # (ams_id, tray_id) whose tray is now empty
  2646. spoolman_held: set[tuple] = set() # removals held for the grace period (#3186)
  2647. for ams_unit in ams_data:
  2648. if not isinstance(ams_unit, dict):
  2649. continue
  2650. ams_id = int(ams_unit.get("id", 0))
  2651. trays = ams_unit.get("tray", [])
  2652. for tray_data in trays:
  2653. if not isinstance(tray_data, dict):
  2654. continue
  2655. tray_id_raw = int(tray_data.get("id", 0))
  2656. tray = client.parse_ams_tray(ams_id, tray_data)
  2657. if not tray:
  2658. # Empty tray slot — record for local assignment cleanup
  2659. # and drop any cached unknown-tag broadcast so a
  2660. # reinserted spool re-prompts.
  2661. #
  2662. # Not during a running print: a slot that empties there
  2663. # is a filament runout, and the spool is still in the
  2664. # AMS. `spoolman_slot_assignments` is how a tag-less
  2665. # spool assigned through the Bambuddy UI is resolved at
  2666. # completion (#1459), so deleting the row mid-print
  2667. # loses the runout segment's usage — the same failure
  2668. # the internal inventory's auto-unlink had.
  2669. #
  2670. # Nor when firmware's presence bit says the slot is
  2671. # occupied. parse_ams_tray calls a tray with no type or
  2672. # no colour empty, and a spool the AMS cannot read has
  2673. # neither until something configures it — so a tag-less
  2674. # spool assigned through the UI had its row deleted by
  2675. # the first idle push after it was inserted. Same
  2676. # deletion as the internal inventory's in #3100, same
  2677. # answer, so the two modes stay in step.
  2678. #
  2679. # And only once the slot has stayed empty for the grace
  2680. # period -- the internal inventory's #3186 answer, for
  2681. # the same one-push blank.
  2682. linked_spool = spoolman_slot_map.get((ams_id, tray_id_raw))
  2683. hold_key = ("spoolman", ams_id, tray_id_raw, linked_spool)
  2684. if not printing_now and (
  2685. spool_present(tray_data) is not True or slot_unlink_grace.is_held(printer_id, hold_key)
  2686. ):
  2687. if linked_spool is None or slot_unlink_grace.removal_confirmed(printer_id, hold_key):
  2688. empty_slots.append((ams_id, tray_id_raw))
  2689. else:
  2690. spoolman_held.add(hold_key)
  2691. logger.info(
  2692. "Spoolman slot unlink held: AMS%d-T%d (spool %d) reports empty; "
  2693. "unlinking if it is still empty in %ds",
  2694. ams_id,
  2695. tray_id_raw,
  2696. linked_spool,
  2697. int(slot_unlink_grace.GRACE_SECONDS),
  2698. )
  2699. _clear_unknown_tag_dedup(printer_id, ams_id, tray_id_raw)
  2700. continue
  2701. spool_tag = (
  2702. tray.tray_uuid
  2703. if tray.tray_uuid and tray.tray_uuid != "00000000000000000000000000000000"
  2704. else tray.tag_uid
  2705. )
  2706. # Provide the hint only when no RFID is available
  2707. hint = spoolman_slot_map.get((ams_id, tray.tray_id)) if not spool_tag else None
  2708. try:
  2709. inv_remaining = inventory_weights.get((ams_id, tray.tray_id))
  2710. result = await client.sync_ams_tray(
  2711. tray,
  2712. printer_name,
  2713. db,
  2714. # Per-print tracking is the only weight writer (#1119).
  2715. # AMS auto-sync still maintains spool metadata / slot
  2716. # assignments but no longer touches remaining_weight.
  2717. disable_weight_sync=True,
  2718. cached_spools=cached_spools,
  2719. inventory_remaining=inv_remaining,
  2720. spoolman_spool_id_hint=hint,
  2721. auto_add_unknown_rfid=auto_add_unknown_rfid,
  2722. )
  2723. if result is None and spool_tag and not auto_add_unknown_rfid:
  2724. # Spoolman skipped auto-create per user setting — surface
  2725. # the slot so the UI can offer "+ Add to inventory".
  2726. await _broadcast_unknown_tag(
  2727. printer_id=printer_id,
  2728. ams_id=ams_id,
  2729. tray_id=tray.tray_id,
  2730. tag_uid=tray.tag_uid or "",
  2731. tray_uuid=tray.tray_uuid or "",
  2732. tray_type=tray.tray_type,
  2733. tray_color=tray.tray_color,
  2734. tray_sub_brands=tray.tray_sub_brands,
  2735. tray_count=len(trays),
  2736. )
  2737. elif result:
  2738. _clear_unknown_tag_dedup(printer_id, ams_id, tray.tray_id)
  2739. if result:
  2740. synced += 1
  2741. if result.get("id"):
  2742. slot_changes.append((ams_id, tray.tray_id, result["id"]))
  2743. # If a new spool was created, add it to the cache
  2744. # so subsequent trays can find it if they reference the same tag
  2745. spool_exists = any(s.get("id") == result["id"] for s in cached_spools)
  2746. if not spool_exists:
  2747. cached_spools.append(result)
  2748. logger.debug(
  2749. "[Printer %s] Added newly created spool %s to cache",
  2750. printer_id,
  2751. result["id"],
  2752. )
  2753. # Reconcile slot_preset_mappings (the same row internal
  2754. # mode keeps in sync via inventory + spool_tag_matcher).
  2755. # Without this the slot card surfaces the previous spool's
  2756. # preset name — same bug shape, different inventory mode.
  2757. from backend.app.services.slot_preset_writer import (
  2758. upsert_slot_preset_for_spoolman_spool,
  2759. )
  2760. await upsert_slot_preset_for_spoolman_spool(
  2761. db=db,
  2762. spoolman_spool=result,
  2763. tray_info_idx=tray.tray_info_idx or "",
  2764. tray_sub_brands=tray.tray_sub_brands or "",
  2765. tray_type=tray.tray_type or "",
  2766. printer_id=printer_id,
  2767. ams_id=ams_id,
  2768. tray_id=tray.tray_id,
  2769. )
  2770. except Exception as e:
  2771. logger.error("Error syncing AMS %s tray %s: %s", ams_id, tray.tray_id, e)
  2772. slot_unlink_grace.settle(printer_id, "spoolman", spoolman_held)
  2773. if synced > 0:
  2774. logger.info("Auto-synced %s AMS trays to Spoolman for printer %s", synced, printer_id)
  2775. # Persist slot assignment changes to the local table
  2776. if slot_changes or empty_slots:
  2777. try:
  2778. for ams_id, tray_id, spool_id in slot_changes:
  2779. await db.execute(
  2780. text(
  2781. "INSERT INTO spoolman_slot_assignments"
  2782. " (printer_id, ams_id, tray_id, spoolman_spool_id)"
  2783. " VALUES (:printer_id, :ams_id, :tray_id, :spool_id)"
  2784. " ON CONFLICT(printer_id, ams_id, tray_id)"
  2785. " DO UPDATE SET spoolman_spool_id = excluded.spoolman_spool_id"
  2786. ),
  2787. {
  2788. "printer_id": printer_id,
  2789. "ams_id": ams_id,
  2790. "tray_id": tray_id,
  2791. "spool_id": spool_id,
  2792. },
  2793. )
  2794. for ams_id, tray_id in empty_slots:
  2795. await db.execute(
  2796. delete(SpoolmanSlotAssignment).where(
  2797. SpoolmanSlotAssignment.printer_id == printer_id,
  2798. SpoolmanSlotAssignment.ams_id == ams_id,
  2799. SpoolmanSlotAssignment.tray_id == tray_id,
  2800. )
  2801. )
  2802. await db.commit()
  2803. except Exception as e:
  2804. await db.rollback()
  2805. logger.error("Error persisting Spoolman slot assignments for printer %s: %s", printer_id, e)
  2806. else:
  2807. # Tell open browsers the slot changed. This loop rewrites
  2808. # slot_preset_mappings via upsert_slot_preset_for_spoolman_spool
  2809. # above, and the AMS slot card reads that row ahead of the
  2810. # live tray_info_idx -- so with no event the card keeps
  2811. # showing the previous spool's preset name. Internal mode
  2812. # raises spool_auto_assigned for the same reason; this loop
  2813. # broadcast nothing at all, which made Spoolman mode the
  2814. # worse half of the same bug. On the else branch so a
  2815. # failed commit stays silent and a broadcast failure cannot
  2816. # roll back rows that are already committed.
  2817. for ams_id, tray_id, *_ in (*slot_changes, *empty_slots):
  2818. await ws_manager.broadcast(
  2819. {
  2820. "type": "spool_assignment_changed",
  2821. "printer_id": printer_id,
  2822. "ams_id": ams_id,
  2823. "tray_id": tray_id,
  2824. }
  2825. )
  2826. except Exception as e:
  2827. logging.getLogger(__name__).error("Spoolman AMS sync failed for printer %s: %s", printer_id, e)
  2828. # Largest finish photo attached to a notification; a bigger one is still linked.
  2829. _FINISH_PHOTO_ATTACH_MAX_BYTES = 2_500_000
  2830. async def _finish_photo_for_notification(
  2831. db, archive, archive_id: int, filename: str
  2832. ) -> tuple[str | None, bytes | None]:
  2833. """The ``{finish_photo_url}`` link and the bytes to attach, for a print's finish photo.
  2834. With authentication off the link is the archive's own photo route, as it
  2835. always was: it opens without a login and doesn't expire. With
  2836. authentication on that route needs a media token, which nothing tapping a
  2837. link in Telegram, CallMeBot or a Home Assistant notification has, so the
  2838. link only ever answered 401. The photo is then saved as a notification
  2839. photo as well (utils/notification_photos.py) and the link points there: an
  2840. unguessable name that opens this one photo and nothing else, for 3 days.
  2841. The link is relative when no External URL is set. Bytes over
  2842. ``_FINISH_PHOTO_ATTACH_MAX_BYTES`` are linked but not attached. Returns
  2843. ``(None, None)`` when the photo can't be found.
  2844. """
  2845. from backend.app.api.routes.settings import get_setting
  2846. from backend.app.core.auth import is_auth_enabled
  2847. from backend.app.utils.archive_paths import find_archive_photo
  2848. from backend.app.utils.notification_photos import save_notification_photo
  2849. log = logging.getLogger(__name__)
  2850. base = ((await get_setting(db, "external_url")) or "").strip().rstrip("/")
  2851. url: str | None = f"{base}/api/v1/archives/{archive_id}/photos/{filename}"
  2852. photo_bytes: bytes | None = None
  2853. try:
  2854. photo_path = find_archive_photo(archive, filename)
  2855. if photo_path is not None:
  2856. photo_bytes = await asyncio.to_thread(photo_path.read_bytes)
  2857. except Exception as e:
  2858. log.warning("[NOTIFY-BG] Failed to read finish photo bytes: %s", e)
  2859. try:
  2860. auth_on = await is_auth_enabled(db)
  2861. except Exception:
  2862. auth_on = True # Unknown: the archive link may need a login, so don't rely on it.
  2863. if auth_on:
  2864. url = None
  2865. if photo_bytes:
  2866. try:
  2867. name = await asyncio.to_thread(save_notification_photo, photo_bytes, "print_complete")
  2868. url = f"{base}/api/v1/notifications/photos/{name}"
  2869. except Exception as e:
  2870. log.warning("[NOTIFY-BG] Failed to save finish photo for its link: %s", e)
  2871. if photo_bytes is not None and len(photo_bytes) > _FINISH_PHOTO_ATTACH_MAX_BYTES:
  2872. log.warning("[NOTIFY-BG] Finish photo too large for attachment: %s bytes", len(photo_bytes))
  2873. return url, None
  2874. if photo_bytes:
  2875. log.info("[NOTIFY-BG] Loaded finish photo bytes: %s bytes", len(photo_bytes))
  2876. return url, photo_bytes
  2877. async def _capture_snapshot_for_notification(printer_id: int, printer, logger) -> bytes | None:
  2878. """Capture a camera snapshot for notification image attachment.
  2879. Returns JPEG bytes (max 2.5MB) or None if capture fails or is unavailable.
  2880. Uses: external camera > buffered frame > fresh capture.
  2881. """
  2882. if not printer:
  2883. return None
  2884. try:
  2885. from backend.app.api.routes.settings import get_setting
  2886. async with async_session() as db:
  2887. capture_enabled = await get_setting(db, "capture_finish_photo")
  2888. if capture_enabled is not None and capture_enabled.lower() != "true":
  2889. return None
  2890. # Try external camera first
  2891. if printer.external_camera_enabled and printer.external_camera_url:
  2892. logger.info("[SNAPSHOT] Capturing from external camera for printer %s", printer_id)
  2893. from backend.app.api.routes.camera import live_frame_for_capture
  2894. from backend.app.services.external_camera import capture_frame
  2895. # An external camera allows one reader, so capturing while a viewer
  2896. # is attached fails (#2707). A None here falls through to the paths
  2897. # below exactly as a failed capture did.
  2898. defer, buffered = live_frame_for_capture(printer_id)
  2899. if defer:
  2900. frame_data = buffered
  2901. else:
  2902. frame_data = await capture_frame(
  2903. printer.external_camera_url,
  2904. printer.external_camera_type or "mjpeg",
  2905. snapshot_url=printer.external_camera_snapshot_url,
  2906. )
  2907. if frame_data and len(frame_data) <= 2_500_000:
  2908. logger.info("[SNAPSHOT] External camera frame: %s bytes", len(frame_data))
  2909. return _apply_camera_rotation(frame_data, printer, logger)
  2910. # Try buffered frame from active stream
  2911. from backend.app.api.routes.camera import _active_chamber_streams, _active_streams, get_buffered_frame
  2912. active_for_printer = [k for k in _active_streams if k.startswith(f"{printer_id}-")]
  2913. active_chamber = [k for k in _active_chamber_streams if k.startswith(f"{printer_id}-")]
  2914. buffered_frame = get_buffered_frame(printer_id)
  2915. if (active_for_printer or active_chamber) and buffered_frame:
  2916. logger.info("[SNAPSHOT] Using buffered frame for printer %s: %s bytes", printer_id, len(buffered_frame))
  2917. if len(buffered_frame) <= 2_500_000:
  2918. return _apply_camera_rotation(buffered_frame, printer, logger)
  2919. # Fresh capture from printer camera
  2920. logger.info("[SNAPSHOT] Capturing fresh frame for printer %s", printer_id)
  2921. from backend.app.services.camera import capture_camera_frame_bytes
  2922. frame_data = await capture_camera_frame_bytes(
  2923. printer.ip_address, printer.access_code, printer.model, timeout=15
  2924. )
  2925. if frame_data and len(frame_data) <= 2_500_000:
  2926. logger.info("[SNAPSHOT] Fresh camera frame: %s bytes", len(frame_data))
  2927. return _apply_camera_rotation(frame_data, printer, logger)
  2928. except Exception as e:
  2929. logger.warning("[SNAPSHOT] Failed to capture snapshot for printer %s: %s", printer_id, e)
  2930. return None
  2931. async def _maybe_bank_inprint_frame(printer_id: int, layer_num: int) -> None:
  2932. """#1867: bank a recent in-print camera frame for the finish photo.
  2933. Called on every layer change and (#2547) on every print-progress advance.
  2934. Grabs one frame (throttled) into ``_inprint_frame_bank`` so the finish-photo
  2935. path has a pre-End-G-code image for prints that end with a plate swap.
  2936. Both drivers are print telemetry that stops the instant printing ends: no
  2937. further layers, and progress freezes before the End G-code (e.g. SwapMod
  2938. plate swap) executes. So the last banked frame is always the finished print,
  2939. never the swapped plate — that property is what the #1867 path relies on and
  2940. it must survive any change to the throttle below.
  2941. Layer changes alone were not enough: they stop when the *final* layer
  2942. begins, which on a three-minute last layer left the bank stale by the whole
  2943. length of that layer (#2547). Progress keeps ticking through it.
  2944. Best-effort: any failure just leaves the previous banked frame.
  2945. """
  2946. logger = logging.getLogger(__name__)
  2947. client = printer_manager.get_client(printer_id)
  2948. state = client.state if client else None
  2949. if not state or state.state != "RUNNING":
  2950. return
  2951. # Only during actual extrusion — firmware ticks layer_num during the
  2952. # pre-print calibration sequence, whose sub-stages are non-zero.
  2953. if state.mc_print_sub_stage not in (None, 0):
  2954. return
  2955. # #2547: throttled uniformly, with no last-layer exemption. The old code
  2956. # bypassed the throttle on the final layer to guarantee a fresh frame there;
  2957. # now that progress advances also drive banking, that exemption would fire a
  2958. # camera grab on every percent tick of the last layer. Bambu printers accept
  2959. # one RTSP client at a time, so each grab contends with the live view.
  2960. now = time.monotonic()
  2961. last = _inprint_frame_bank_ts.get(printer_id, 0.0)
  2962. if (now - last) < _INPRINT_BANK_MIN_INTERVAL:
  2963. return
  2964. total = state.total_layers or 0
  2965. try:
  2966. async with async_session() as db:
  2967. from backend.app.models.printer import Printer
  2968. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  2969. printer = result.scalar_one_or_none()
  2970. if not printer:
  2971. return
  2972. # Reuses the notification snapshot path, which honours the
  2973. # `capture_finish_photo` setting (returns None when disabled) so we
  2974. # don't bank frames the user never asked for.
  2975. frame = await _capture_snapshot_for_notification(printer_id, printer, logger)
  2976. if frame:
  2977. _inprint_frame_bank[printer_id] = frame
  2978. _inprint_frame_bank_ts[printer_id] = now
  2979. logger.debug(
  2980. "[FINISH-PHOTO-BANK] banked in-print frame for printer %s at layer %s/%s (%d bytes)",
  2981. printer_id,
  2982. layer_num,
  2983. total,
  2984. len(frame),
  2985. )
  2986. except Exception as e:
  2987. logger.debug("[FINISH-PHOTO-BANK] bank failed for printer %s: %s", printer_id, e)
  2988. def _apply_camera_rotation(image_data: bytes, printer, logger) -> bytes:
  2989. """Apply camera rotation to snapshot image if configured."""
  2990. from backend.app.services.camera import apply_camera_rotation
  2991. return apply_camera_rotation(image_data, getattr(printer, "camera_rotation", 0), logger)
  2992. async def _send_print_start_notification(
  2993. printer_id: int,
  2994. data: dict,
  2995. archive_data: dict | None = None,
  2996. logger=None,
  2997. ):
  2998. """Helper to send print start notification with optional archive data."""
  2999. if logger is None:
  3000. logger = logging.getLogger(__name__)
  3001. try:
  3002. async with async_session() as db:
  3003. from backend.app.models.printer import Printer
  3004. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  3005. printer = result.scalar_one_or_none()
  3006. printer_name = printer.name if printer else f"Printer {printer_id}"
  3007. # Capture camera snapshot for notification image attachment
  3008. image_data = await _capture_snapshot_for_notification(printer_id, printer, logger)
  3009. if image_data:
  3010. if archive_data is None:
  3011. archive_data = {}
  3012. archive_data["image_data"] = image_data
  3013. await notification_service.on_print_start(printer_id, printer_name, data, db, archive_data=archive_data)
  3014. # Send user-specific email notification for print start
  3015. if archive_data and archive_data.get("created_by_id"):
  3016. await notification_service.send_user_print_email(
  3017. event_type="user_print_start",
  3018. created_by_id=archive_data["created_by_id"],
  3019. printer_name=printer_name,
  3020. filename=data.get("subtask_name") or data.get("filename", "Unknown"),
  3021. db=db,
  3022. )
  3023. except Exception as e:
  3024. logger.warning("Notification on_print_start failed: %s", e)
  3025. async def _dispatch_user_print_email(
  3026. status: str,
  3027. created_by_id: int | None,
  3028. printer_name: str,
  3029. filename: str,
  3030. db,
  3031. image_data: bytes | None = None,
  3032. finish_photo_url: str | None = None,
  3033. ) -> None:
  3034. """Send a user-specific print-completion email based on print status.
  3035. Maps the normalised print status to the correct event type and delegates
  3036. to :meth:`NotificationService.send_user_print_email`. A single helper
  3037. avoids duplicating the ``if status == "completed" / elif "failed" / elif
  3038. "stopped"`` dispatch block at every call site.
  3039. Does nothing if *created_by_id* is ``None``.
  3040. """
  3041. if created_by_id is None:
  3042. return
  3043. if status == "completed":
  3044. event_type = "user_print_complete"
  3045. elif status == "failed":
  3046. event_type = "user_print_failed"
  3047. elif status in ("stopped", "aborted", "cancelled"):
  3048. event_type = "user_print_stopped"
  3049. else:
  3050. return
  3051. await notification_service.send_user_print_email(
  3052. event_type=event_type,
  3053. created_by_id=created_by_id,
  3054. printer_name=printer_name,
  3055. filename=filename,
  3056. db=db,
  3057. image_data=image_data,
  3058. finish_photo_url=finish_photo_url,
  3059. )
  3060. def _load_objects_from_archive(archive, printer_id: int, logger) -> None:
  3061. """Extract printable objects from an archive's 3MF file and store in printer state."""
  3062. try:
  3063. from backend.app.services.archive import extract_printable_objects_from_archive
  3064. client = printer_manager.get_client(printer_id)
  3065. if not client:
  3066. return
  3067. # Extract with positions for UI overlay, scoped to the plate that
  3068. # is printing — resolve_plate_id is the same resolver /cover uses,
  3069. # so the object list can't disagree with the thumbnail it is drawn
  3070. # over (#2522).
  3071. printable_objects, bbox_all = extract_printable_objects_from_archive(
  3072. app_settings.base_dir / archive.file_path,
  3073. plate_number=resolve_plate_id(client.state),
  3074. )
  3075. if printable_objects:
  3076. client.state.printable_objects = printable_objects
  3077. client.state.printable_objects_bbox_all = bbox_all
  3078. client.state.skipped_objects = []
  3079. logger.info("Loaded %s printable objects for printer %s", len(printable_objects), printer_id)
  3080. except Exception as e:
  3081. logger.debug("Failed to extract printable objects from archive: %s", e)
  3082. async def _restore_printable_objects(printer_id: int, state, db, logger) -> None:
  3083. """Put the skip-objects list back after a restart mid-print.
  3084. ``PrinterState.printable_objects`` is in-memory only, and the only thing
  3085. that fills it is ``_load_objects_from_archive`` on the print-start paths —
  3086. which the #1304 guard suppresses on the first RUNNING push after startup.
  3087. Everything else this hook restores (the archive, the usage-tracking session,
  3088. the timelapse baseline) was already handled; the object list was not, so a
  3089. restart mid-print took skip-objects away for the rest of that print.
  3090. Nothing recovered it either: the printer card gates its Skip button on the
  3091. object count, and the one endpoint that can rebuild the list is reachable
  3092. only from the modal that button opens.
  3093. Anchored on ``subtask_id``, which the firmware mints per print, so a
  3094. leftover ``status="printing"`` row from a completion we never saw cannot
  3095. hand this print someone else's objects. Without one, nothing is loaded
  3096. rather than guessed — the reload path on ``GET /print/objects`` covers that
  3097. case on demand.
  3098. """
  3099. client = printer_manager.get_client(printer_id)
  3100. if client is None or client.state.printable_objects:
  3101. return
  3102. subtask_id = str(getattr(state, "subtask_id", "") or "").strip()
  3103. if subtask_id in ("", "0"):
  3104. return
  3105. from backend.app.models.archive import PrintArchive
  3106. archive = await db.scalar(
  3107. select(PrintArchive)
  3108. .where(
  3109. PrintArchive.printer_id == printer_id,
  3110. PrintArchive.status == "printing",
  3111. PrintArchive.subtask_id == subtask_id,
  3112. )
  3113. .order_by(PrintArchive.created_at.desc())
  3114. .limit(1)
  3115. )
  3116. if archive is not None:
  3117. _load_objects_from_archive(archive, printer_id, logger)
  3118. # Retry ladder for a fallback archive created while the printer's FTPS cool-off
  3119. # was running (#2957). The cool-off is 300s, so the first attempt is placed just
  3120. # past it; the second covers a handshake that failed again on the way back and
  3121. # armed a fresh one. Module-level so tests can shrink them.
  3122. _FALLBACK_3MF_RETRY_DELAYS_SECONDS: tuple[float, ...] = (310.0, 620.0)
  3123. # Retry ladder for the other temporary give-up: the file service answered and
  3124. # the transfer still did not finish, which at print start is usually the printer
  3125. # serving MQTT, the camera and a job upload at the same time (#3063). Nothing has
  3126. # to expire here, so the first attempt comes early -- #3063's reporter had the
  3127. # same 19MB file complete 48 seconds after the download budget ran out. The later
  3128. # two cover a printer that stays busy well into the print.
  3129. _FALLBACK_3MF_TRANSFER_RETRY_DELAYS_SECONDS: tuple[float, ...] = (60.0, 240.0, 600.0)
  3130. # printer_id -> the in-flight retry task, so print completion can cancel it.
  3131. _fallback_3mf_retry_tasks: dict[int, asyncio.Task] = {}
  3132. # printer_id -> lock serialising recovery attempts for that printer. Three callers
  3133. # can reach one archive at once: the cover endpoint (whose single-flight coalesces
  3134. # by view, so two views race), the cool-off retry task, and print completion.
  3135. # Without this they each read file_path == "" and each run a full copy, so the row
  3136. # ends up pointing at one timestamped directory while the others sit orphaned.
  3137. #
  3138. # Keyed by printer rather than archive because a printer runs one print at a time,
  3139. # which makes the two equally strong here — and it bounds the dict by printer
  3140. # count instead of needing a cleanup pass. Popping a per-archive entry cannot be
  3141. # done safely: `Lock.locked()` reads False between release and the queued waiter
  3142. # resuming, so "no waiters" is not a question this API can answer.
  3143. _fallback_recovery_locks: dict[int, asyncio.Lock] = {}
  3144. async def _recover_fallback_archive(archive_id: int, source_3mf: Path, printer_id: int) -> bool:
  3145. """Fill in a no-3MF archive from a 3MF that turned up later.
  3146. Returns True when the row was upgraded. Safe to call speculatively: it
  3147. verifies the archive still exists, is still a fallback, and that the file
  3148. is a readable 3MF before touching anything.
  3149. Serialised per printer — see ``_fallback_recovery_locks``.
  3150. """
  3151. lock = _fallback_recovery_locks.setdefault(printer_id, asyncio.Lock())
  3152. async with lock:
  3153. return await _recover_fallback_archive_locked(archive_id, source_3mf, printer_id)
  3154. async def _recover_fallback_archive_locked(archive_id: int, source_3mf: Path, printer_id: int) -> bool:
  3155. """The body of :func:`_recover_fallback_archive`, under its per-printer lock."""
  3156. import zipfile
  3157. from backend.app.models.archive import PrintArchive
  3158. from backend.app.services.archive import ArchiveService
  3159. logger = logging.getLogger(__name__)
  3160. if not source_3mf.exists() or source_3mf.stat().st_size == 0:
  3161. return False
  3162. if not await asyncio.to_thread(zipfile.is_zipfile, source_3mf):
  3163. # A truncated or half-written download is worse than no download: it
  3164. # would replace an honest empty archive with wrong metadata.
  3165. logger.warning("[RECOVER] %s is not a readable 3MF; leaving archive %s as-is", source_3mf, archive_id)
  3166. return False
  3167. async with async_session() as db:
  3168. archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  3169. if archive is None or archive.deleted_at is not None:
  3170. return False
  3171. if archive.file_path:
  3172. # Already recovered, or never was a fallback. Either way there is a
  3173. # real 3MF attached and overwriting it is not this function's job.
  3174. return False
  3175. print_data = (archive.extra_data or {}).get("_print_data") or {}
  3176. service = ArchiveService(db)
  3177. recovered = await service.archive_print(
  3178. printer_id=printer_id,
  3179. source_file=source_3mf,
  3180. print_data={**print_data, "status": archive.status or "printing"},
  3181. subtask_id=archive.subtask_id,
  3182. update_archive_id=archive.id,
  3183. )
  3184. if recovered is None:
  3185. return False
  3186. logger.info(
  3187. "[RECOVER] Archive %s filled in from %s (%s bytes) — it started as a no-3MF fallback",
  3188. archive_id,
  3189. source_3mf,
  3190. recovered.file_size,
  3191. )
  3192. # `archive_updated`, not `archive_created` — the row was already on the
  3193. # Archives page as an empty card and is now filled in, not new.
  3194. await ws_manager.send_archive_updated(
  3195. {
  3196. "id": recovered.id,
  3197. "printer_id": recovered.printer_id,
  3198. "filename": recovered.filename,
  3199. "print_name": recovered.print_name,
  3200. "status": recovered.status,
  3201. }
  3202. )
  3203. return True
  3204. async def try_recover_fallback_archive(printer_id: int, name: str, path: Path) -> bool:
  3205. """Offer a freshly-downloaded 3MF to this printer's running fallback archive.
  3206. Called from the paths that pull a 3MF for a print that is already under way
  3207. — chiefly the cover endpoint, which downloads the very file the archive flow
  3208. could not get and, before #2957, used it for a thumbnail and nothing else.
  3209. The bytes are already local, so this costs a parse and a row update.
  3210. No-op when the running print has a real archive, which is the common case.
  3211. """
  3212. from backend.app.models.archive import PrintArchive
  3213. logger = logging.getLogger(__name__)
  3214. # `_active_prints` is keyed on the raw names seen at print start — the
  3215. # dispatch filename, the subtask name, and the subtask name plus ".3mf".
  3216. # Callers here arrive with whichever variant their own path produced, so
  3217. # match on the same normalization the download cache uses rather than on an
  3218. # exact string; that is what makes "Desktop_Goose.gcode.3mf" from the cover
  3219. # endpoint find an archive registered under "Desktop_Goose".
  3220. wanted = normalize_3mf_name(name)
  3221. archive_id = None
  3222. for (key_printer_id, key_name), value in list(_active_prints.items()):
  3223. if key_printer_id == printer_id and normalize_3mf_name(key_name) == wanted:
  3224. archive_id = value
  3225. break
  3226. if archive_id is None:
  3227. return False
  3228. async with async_session() as db:
  3229. archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  3230. # Cheap pre-check so the common case (a normal archive) does no work.
  3231. if archive is None or archive.file_path or archive.deleted_at is not None:
  3232. return False
  3233. try:
  3234. return await _recover_fallback_archive(archive_id, path, printer_id)
  3235. except Exception as e:
  3236. # Recovery is opportunistic. A failure here must never take down the
  3237. # caller, which is usually just trying to render a thumbnail.
  3238. logger.warning("[RECOVER] Could not fill in archive %s from %s: %s", archive_id, path, e)
  3239. return False
  3240. def _schedule_fallback_3mf_retry(
  3241. printer_id: int,
  3242. archive_id: int,
  3243. filenames: list[str],
  3244. delays: tuple[float, ...] | None = None,
  3245. reason: str = REASON_FTPS_COOLOFF,
  3246. ) -> None:
  3247. """Re-attempt the 3MF download after a temporary give-up.
  3248. ``reason`` says which give-up this is, and picks the default ladder: an
  3249. FTPS cool-off has to be waited out, while a transfer that timed out under
  3250. contention is worth asking about again straight away (#3063). It is only
  3251. read for the ladder and the log line -- the retry itself is identical, since
  3252. in both cases the file is on the printer and the last attempt at it failed
  3253. for a reason that does not last.
  3254. """
  3255. logger = logging.getLogger(__name__)
  3256. if delays is None:
  3257. delays = (
  3258. _FALLBACK_3MF_TRANSFER_RETRY_DELAYS_SECONDS
  3259. if reason == REASON_FTP_TRANSFER_FAILED
  3260. else _FALLBACK_3MF_RETRY_DELAYS_SECONDS
  3261. )
  3262. async def _retry() -> None:
  3263. from backend.app.models.archive import PrintArchive
  3264. from backend.app.models.printer import Printer
  3265. for delay in delays:
  3266. await asyncio.sleep(delay)
  3267. async with async_session() as db:
  3268. archive = (
  3269. await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  3270. ).scalar_one_or_none()
  3271. if archive is None or archive.deleted_at is not None or archive.file_path:
  3272. return
  3273. printer = (await db.execute(select(Printer).where(Printer.id == printer_id))).scalar_one_or_none()
  3274. if printer is None:
  3275. return
  3276. # Read the fields while the session is open rather than touching
  3277. # a detached instance minutes later, mid-download.
  3278. printer_ip = printer.ip_address
  3279. printer_code = printer.access_code
  3280. printer_model = printer.model
  3281. # Someone else may have fetched it in the meantime — the cover
  3282. # endpoint routinely does, and its copy is the same bytes.
  3283. for name in filenames:
  3284. cached = get_cached_3mf(printer_id, name)
  3285. if cached and await _recover_fallback_archive(archive_id, cached, printer_id):
  3286. return
  3287. if ftps_handshake_blocked(printer_ip):
  3288. logger.info(
  3289. "[RECOVER] Printer %s is still in its FTPS cool-off; archive %s retry deferred",
  3290. printer_id,
  3291. archive_id,
  3292. )
  3293. continue
  3294. _, _, _, ftp_timeout = await get_ftp_retry_settings()
  3295. for candidate in filenames:
  3296. # Bare name only. These come from the print-start flow, which
  3297. # already strips the path, but the local temp write must not
  3298. # depend on that holding for every future caller — a name that
  3299. # is absolute or contains ".." would otherwise escape the data
  3300. # volume via the `/` operator.
  3301. name = Path(candidate).name
  3302. if not name or name in (".", ".."):
  3303. continue
  3304. if not name.endswith(".3mf"):
  3305. name = f"{name}.3mf"
  3306. temp_path = app_settings.archive_dir / "temp" / name
  3307. temp_path.parent.mkdir(parents=True, exist_ok=True)
  3308. try:
  3309. hit = await download_file_try_paths_async(
  3310. printer_ip,
  3311. printer_code,
  3312. ftp_probe_paths(name),
  3313. temp_path,
  3314. socket_timeout=ftp_timeout,
  3315. printer_model=printer_model,
  3316. )
  3317. except Exception as e:
  3318. logger.debug("[RECOVER] Retry download of %s failed: %s", name, e)
  3319. continue
  3320. if not hit:
  3321. continue
  3322. cache_3mf_download(printer_id, name, temp_path)
  3323. if await _recover_fallback_archive(archive_id, temp_path, printer_id):
  3324. return
  3325. logger.info("[RECOVER] Archive %s still has no 3MF after a retry", archive_id)
  3326. async def _guarded() -> None:
  3327. try:
  3328. await _retry()
  3329. except asyncio.CancelledError:
  3330. raise
  3331. except Exception as e:
  3332. logger.warning("[RECOVER] Retry task for archive %s failed: %s", archive_id, e)
  3333. finally:
  3334. if _fallback_3mf_retry_tasks.get(printer_id) is asyncio.current_task():
  3335. _fallback_3mf_retry_tasks.pop(printer_id, None)
  3336. existing = _fallback_3mf_retry_tasks.pop(printer_id, None)
  3337. if existing and not existing.done():
  3338. existing.cancel()
  3339. task = asyncio.create_task(_guarded())
  3340. _fallback_3mf_retry_tasks[printer_id] = task
  3341. logger.info(
  3342. "[RECOVER] Archive %s has no 3MF (%s) and the file should still be on printer %s; will retry in %s",
  3343. archive_id,
  3344. reason,
  3345. printer_id,
  3346. ", ".join(f"{d:g}s" for d in delays),
  3347. )
  3348. async def _ask_outcome_for_external_print(db, printer_id: int, observed_name: str | None = None) -> bool:
  3349. """Whether an archive created here should ask for the print's outcome (#1898).
  3350. Only a print Bambuddy did not dispatch reaches the archive-*creating*
  3351. branches below: a queued job already has its archive and takes the
  3352. expected-print branch, where the queue item's own ``confirm_outcome``
  3353. decides. The queue is still consulted, because a restart mid-print empties
  3354. ``_expected_prints`` — without the check the setting could override a queue
  3355. item that deliberately has the flag off. Any failure answers "don't ask":
  3356. an unwanted prompt is worse than a missing one, and this must never be the
  3357. reason a print goes unarchived.
  3358. A ``printing`` row is not proof on its own, though: Bambuddy deliberately
  3359. leaves one behind when a completion cannot be matched to it
  3360. (``_completion_belongs_to_queue_item``), and the scheduler's stranded sweep
  3361. only takes it back once the printer has sat connected and terminal for
  3362. minutes. Until then every screen-started print on that printer would
  3363. silently lose its prompt, so the row is held against ``observed_name`` by
  3364. the same comparison a completion uses: a positive disagreement means the row
  3365. is about some other run and this print is external after all.
  3366. """
  3367. logger = logging.getLogger(__name__)
  3368. try:
  3369. # A savepoint rather than a rollback of the caller's transaction on
  3370. # failure: a failed statement leaves the transaction unusable, but a
  3371. # full rollback also expires every object the caller has loaded (the
  3372. # printer, the archive it just created), and on an async session the
  3373. # next attribute read then raises instead of reloading. Everything here
  3374. # is a read, so undoing the savepoint loses nothing.
  3375. async with db.begin_nested():
  3376. return await _decide_outcome_for_external_print(db, printer_id, observed_name, logger)
  3377. except Exception as e:
  3378. logger.warning("[CALLBACK] Could not decide the outcome prompt for printer %s: %s", printer_id, e)
  3379. return False
  3380. async def _decide_outcome_for_external_print(db, printer_id: int, observed_name: str | None, logger) -> bool:
  3381. """The reads behind ``_ask_outcome_for_external_print``; see there."""
  3382. from backend.app.api.routes.settings import get_setting, setting_is_true
  3383. if not setting_is_true(await get_setting(db, "confirm_outcome_external_prints")):
  3384. return False
  3385. from backend.app.models.print_queue import PrintQueueItem
  3386. dispatched_here = await db.scalar(
  3387. select(PrintQueueItem)
  3388. .where(
  3389. PrintQueueItem.printer_id == printer_id,
  3390. PrintQueueItem.status == "printing",
  3391. )
  3392. .limit(1)
  3393. )
  3394. if dispatched_here is None:
  3395. return True
  3396. expected = await _queue_item_dispatched_name(db, dispatched_here)
  3397. observed = (observed_name or "").strip()
  3398. if not expected or not observed or _subtask_names_match(expected, observed):
  3399. logger.info(
  3400. "[CALLBACK] Not asking for the outcome on printer %s: queue item %s is still printing, so "
  3401. "Bambuddy dispatched this run and the item's own ask-for-outcome flag decides.",
  3402. printer_id,
  3403. dispatched_here.id,
  3404. )
  3405. return False
  3406. logger.info(
  3407. "[CALLBACK] Queue item %s is still marked printing on printer %s but was dispatched as %r, not "
  3408. "%r; treating this as an externally started print.",
  3409. dispatched_here.id,
  3410. printer_id,
  3411. expected,
  3412. observed,
  3413. )
  3414. return True
  3415. async def _dispatch_outcome_confirmation_safely(
  3416. db,
  3417. printer_id: int,
  3418. printer_name: str,
  3419. data: dict,
  3420. archive_id: int,
  3421. archive_data: dict | None = None,
  3422. ) -> None:
  3423. """``dispatch_outcome_confirmation`` for a caller that has more to do on ``db``.
  3424. The completion task sends the per-user print email on the same session
  3425. right after the prompt. A failed statement in the prompt leaves that
  3426. session needing a rollback, and without one the email step fails with
  3427. PendingRollbackError; the prompt is the optional part, so it must not be
  3428. the reason the email never goes out.
  3429. """
  3430. try:
  3431. await dispatch_outcome_confirmation(db, printer_id, printer_name, data, archive_id, archive_data)
  3432. except Exception as e:
  3433. logging.getLogger(__name__).error("[NOTIFY-BG] Outcome-confirmation dispatch failed: %s", e, exc_info=True)
  3434. try:
  3435. await db.rollback()
  3436. except Exception:
  3437. pass
  3438. async def dispatch_outcome_confirmation(
  3439. db,
  3440. printer_id: int,
  3441. printer_name: str,
  3442. data: dict,
  3443. archive_id: int,
  3444. archive_data: dict | None = None,
  3445. ) -> bool:
  3446. """Emit the post-print outcome prompt for a completed archive (#1898).
  3447. Gated on the archive itself: ``confirm_requested`` is the opt-in (from the
  3448. queue item, or from ``confirm_outcome_external_prints`` for a print
  3449. Bambuddy did not start) and ``user_verdict`` being unset is what makes the
  3450. question still open. Mints the per-archive capability token the one-tap
  3451. verdict links carry.
  3452. Lives here rather than inline in ``on_print_complete``'s notification task
  3453. because that task swallows every exception: extracted, the gate and the two
  3454. emissions can be driven by a test, which is the only thing standing between
  3455. a regression here and a farm that quietly stops asking.
  3456. Returns whether a prompt was sent.
  3457. """
  3458. logger = logging.getLogger(__name__)
  3459. from backend.app.models.archive import PrintArchive
  3460. confirm_archive = (await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))).scalar_one_or_none()
  3461. if not (confirm_archive and confirm_archive.confirm_requested and confirm_archive.user_verdict is None):
  3462. return False
  3463. import secrets as _secrets
  3464. # A spent token stays on the row so the one-tap route can recognise it, so
  3465. # "has a token" no longer means "answerable". A prompt going out now needs a
  3466. # live one: mint a new token whenever the stored one is already spent, or
  3467. # every button in the new message would land on the already-answered page.
  3468. if not confirm_archive.confirm_token or confirm_archive.confirm_token_used_at is not None:
  3469. confirm_archive.confirm_token = _secrets.token_urlsafe(32)
  3470. confirm_archive.confirm_token_used_at = None
  3471. await db.commit()
  3472. from backend.app.api.routes.settings import get_external_base_url, get_setting
  3473. base = await get_external_base_url(db)
  3474. if not await get_setting(db, "external_url"):
  3475. # Both the Telegram inline keyboard and the ntfy action buttons need an
  3476. # absolute URL, so an unconfigured install used to get a message body
  3477. # with two unusable relative paths and no buttons at all. The shared
  3478. # fallback at least produces tappable links; say which setting makes
  3479. # them resolve from a phone.
  3480. logger.warning(
  3481. "[#1898] No external_url configured — the outcome prompt's Good/Reject links point at %s. "
  3482. "Set Settings → External URL so they resolve away from this host.",
  3483. base,
  3484. )
  3485. token = confirm_archive.confirm_token
  3486. good_url = f"{base}/api/v1/archives/confirm/{token}/good"
  3487. reject_url = f"{base}/api/v1/archives/confirm/{token}/reject"
  3488. confirm_url = f"{base}/archives?confirm={archive_id}"
  3489. await ws_manager.send_print_confirm_request(
  3490. printer_id,
  3491. {
  3492. "archive_id": archive_id,
  3493. "print_name": confirm_archive.print_name or confirm_archive.filename,
  3494. },
  3495. )
  3496. await notification_service.on_print_confirm_request(
  3497. printer_id,
  3498. printer_name,
  3499. data,
  3500. db,
  3501. archive_data=archive_data,
  3502. good_url=good_url,
  3503. reject_url=reject_url,
  3504. confirm_url=confirm_url,
  3505. archive_id=archive_id,
  3506. )
  3507. return True
  3508. async def on_print_start(printer_id: int, data: dict):
  3509. """Handle print start - archive the 3MF file immediately."""
  3510. logger = logging.getLogger(__name__)
  3511. logger.info("[CALLBACK] on_print_start called for printer %s, data keys: %s", printer_id, list(data.keys()))
  3512. # Clear any stale user-stopped flag from previous print cycles
  3513. _user_stopped_printers.discard(printer_id)
  3514. _kill_switch_notification_tasks.pop(printer_id, None)
  3515. # #1721: drop any leftover pre-captured finish frame from a prior print
  3516. # so a never-consumed cache entry can't bleed into the new print's photo.
  3517. _stage22_finish_frames.pop(printer_id, None)
  3518. # #1867: same for the in-print frame bank — a queued print must not reuse
  3519. # the previous job's banked frame.
  3520. _inprint_frame_bank.pop(printer_id, None)
  3521. _inprint_frame_bank_ts.pop(printer_id, None)
  3522. # #2547: bind (or clear) the "this print ends with injected End G-code" flag.
  3523. # Unconditional, so a print Bambuddy didn't dispatch drops the previous
  3524. # print's flag instead of inheriting it.
  3525. print_dispatch_context.adopt(printer_id)
  3526. # Cancel any active bed cooldown waiter for this printer
  3527. if _bed_cool_waiters.pop(printer_id, None):
  3528. logger.info("[BED-COOL] Cancelled bed cooldown waiter for printer %s (new print started)", printer_id)
  3529. # Clear cached cover images so the new print's thumbnail is fetched fresh
  3530. from backend.app.api.routes.printers import clear_cover_cache
  3531. clear_cover_cache(printer_id)
  3532. await ws_manager.send_print_start(printer_id, data)
  3533. # Notify when the print-start AMS mapping references tray slots without spool assignments.
  3534. await notify_missing_spool_assignments_on_print_start(printer_id, data, logger)
  3535. # MQTT relay - publish print start
  3536. try:
  3537. printer_info = printer_manager.get_printer(printer_id)
  3538. if printer_info:
  3539. await mqtt_relay.on_print_start(
  3540. printer_id,
  3541. printer_info.name,
  3542. printer_info.serial_number,
  3543. data.get("filename", ""),
  3544. data.get("subtask_name", ""),
  3545. )
  3546. except Exception:
  3547. pass # Don't fail print start callback if MQTT fails
  3548. # Capture AMS tray remain%, the assignment snapshot, the dispatched plate
  3549. # and mapping, and the seeded tray-change log.
  3550. #
  3551. # Unconditional, for both inventory backends. This only *captures* — the
  3552. # writing is still split, with the internal tracker skipped at completion
  3553. # when Spoolman owns usage. Spoolman's own durable row (#1820) already
  3554. # carries its plate-scoped 3MF figures and stored mapping, but not the
  3555. # tray-change log, and that log is the only record of which spool fed
  3556. # which layers when AMS Filament Backup swaps trays mid-print. Capturing
  3557. # it on one side only would leave Spoolman users with the mid-print
  3558. # restart bug this fixes for everyone else.
  3559. try:
  3560. async with async_session() as db:
  3561. from backend.app.api.routes.settings import get_setting
  3562. from backend.app.services.usage_tracker import on_print_start as usage_on_print_start
  3563. _spoolman_on = await get_setting(db, "spoolman_enabled")
  3564. await usage_on_print_start(
  3565. printer_id,
  3566. data,
  3567. printer_manager,
  3568. db=db,
  3569. spoolman_owns_usage=bool(_spoolman_on) and _spoolman_on.lower() == "true",
  3570. )
  3571. except Exception as e:
  3572. logger.warning("Usage tracker on_print_start failed: %s", e)
  3573. # Track if notification was sent (to avoid sending twice)
  3574. notification_sent = False
  3575. # Smart plug automation: turn on plug when print starts
  3576. try:
  3577. async with async_session() as db:
  3578. await smart_plug_manager.on_print_start(printer_id, db)
  3579. except Exception as e:
  3580. logger.warning("Smart plug on_print_start failed: %s", e)
  3581. async with async_session() as db:
  3582. from backend.app.models.printer import Printer
  3583. from backend.app.services.bambu_ftp import list_files_async
  3584. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  3585. printer = result.scalar_one_or_none()
  3586. # Plate detection check - pause if objects detected on build plate
  3587. logger.info(
  3588. f"[PLATE CHECK] printer_id={printer_id}, plate_detection_enabled={printer.plate_detection_enabled if printer else 'NO PRINTER'}"
  3589. )
  3590. if printer and printer.plate_detection_enabled:
  3591. logger.info("[PLATE CHECK] ENTERING plate detection code for printer %s", printer_id)
  3592. # Release the pooled DB connection before the plate-detection camera
  3593. # work (a 2.5s light-settle sleep + FTP/camera capture). Only the
  3594. # printer SELECT has run so far — nothing to persist — so this commit
  3595. # is a data-noop that ends the read transaction and returns the
  3596. # connection to the pool during the I/O (issue #2572). expire_on_commit
  3597. # =False keeps printer.* readable; on_plate_not_empty (rare) and the
  3598. # archive lookups below re-acquire a fresh connection on next execute.
  3599. await db.commit()
  3600. try:
  3601. from backend.app.services.plate_detection import check_plate_empty
  3602. # Build ROI tuple from printer settings if available
  3603. roi = None
  3604. if all(
  3605. [
  3606. printer.plate_detection_roi_x is not None,
  3607. printer.plate_detection_roi_y is not None,
  3608. printer.plate_detection_roi_w is not None,
  3609. printer.plate_detection_roi_h is not None,
  3610. ]
  3611. ):
  3612. roi = (
  3613. printer.plate_detection_roi_x,
  3614. printer.plate_detection_roi_y,
  3615. printer.plate_detection_roi_w,
  3616. printer.plate_detection_roi_h,
  3617. )
  3618. # Auto-turn on chamber light if it's off for better detection
  3619. light_was_off = False
  3620. client = printer_manager.get_client(printer_id)
  3621. if client and client.state:
  3622. light_was_off = not client.state.chamber_light
  3623. if light_was_off:
  3624. logger.info("[PLATE CHECK] Turning on chamber light for printer %s", printer_id)
  3625. client.set_chamber_light(True)
  3626. # Wait for light to physically turn on and camera to adjust exposure
  3627. await asyncio.sleep(2.5)
  3628. plate_photo_data = None
  3629. objects_detected = False
  3630. try:
  3631. logger.info("[PLATE CHECK] Running plate detection for printer %s", printer_id)
  3632. plate_result = await check_plate_empty(
  3633. printer_id=printer_id,
  3634. ip_address=printer.ip_address,
  3635. access_code=printer.access_code,
  3636. model=printer.model,
  3637. include_debug_image=False,
  3638. external_camera_url=printer.external_camera_url,
  3639. external_camera_type=printer.external_camera_type,
  3640. use_external=printer.external_camera_enabled,
  3641. roi=roi,
  3642. external_camera_snapshot_url=printer.external_camera_snapshot_url,
  3643. )
  3644. objects_detected = not plate_result.needs_calibration and not plate_result.is_empty
  3645. if objects_detected:
  3646. # Objects detected - pause the print!
  3647. logger.warning(
  3648. f"[PLATE CHECK] Objects detected on plate for printer {printer_id}! "
  3649. f"Confidence: {plate_result.confidence:.0%}, Diff: {plate_result.difference_percent:.1f}%"
  3650. )
  3651. pause_client = printer_manager.get_client(printer_id)
  3652. if pause_client:
  3653. pause_client.pause_print()
  3654. logger.info("[PLATE CHECK] Print paused for printer %s", printer_id)
  3655. # Snapshot while the light's still on — restoring it first
  3656. # would leave the notification with a dark photo.
  3657. try:
  3658. plate_photo_data = await _capture_snapshot_for_notification(printer_id, printer, logger)
  3659. except Exception as snap_err:
  3660. logger.warning(
  3661. "[PLATE CHECK] Failed to capture snapshot for printer %s: %s", printer_id, snap_err
  3662. )
  3663. finally:
  3664. # Restore chamber light to original state as soon as the
  3665. # camera is done with it, whatever happened above.
  3666. if light_was_off and client:
  3667. logger.info("[PLATE CHECK] Restoring chamber light to off for printer %s", printer_id)
  3668. try:
  3669. client.set_chamber_light(False)
  3670. except Exception as light_err:
  3671. logger.warning(
  3672. "[PLATE CHECK] Failed to restore chamber light for printer %s: %s",
  3673. printer_id,
  3674. light_err,
  3675. )
  3676. if objects_detected:
  3677. # Send notification about plate not empty
  3678. await ws_manager.broadcast(
  3679. {
  3680. "type": "plate_not_empty",
  3681. "printer_id": printer_id,
  3682. "printer_name": printer.name,
  3683. "message": f"Objects detected on build plate! Print paused. (Diff: {plate_result.difference_percent:.1f}%)",
  3684. }
  3685. )
  3686. # Also send push notification
  3687. try:
  3688. await notification_service.on_plate_not_empty(
  3689. printer_id=printer_id,
  3690. printer_name=printer.name,
  3691. db=db,
  3692. difference_percent=plate_result.difference_percent,
  3693. image_data=plate_photo_data,
  3694. )
  3695. except Exception as notif_err:
  3696. logger.warning("[PLATE CHECK] Failed to send notification: %s", notif_err)
  3697. else:
  3698. logger.info("[PLATE CHECK] Plate is empty for printer %s, proceeding with print", printer_id)
  3699. except Exception as plate_err:
  3700. # Don't block print on plate detection errors
  3701. logger.warning("[PLATE CHECK] Plate detection failed for printer %s: %s", printer_id, plate_err)
  3702. if not printer:
  3703. logger.info("[CALLBACK] Skipping archive - printer not found in database")
  3704. if not notification_sent:
  3705. await _send_print_start_notification(printer_id, data, logger=logger)
  3706. return
  3707. if not printer.auto_archive:
  3708. # auto-archive disabled — check if there's an expected print (dispatched
  3709. # by BamBuddy via queue/reprint) that already has an archive to promote.
  3710. # If so, fall through to the expected-print handling below so the archive
  3711. # is tracked in _active_prints and usage tracking works at completion.
  3712. _fn = data.get("filename", "")
  3713. _sn = data.get("subtask_name", "")
  3714. _check_keys: list[tuple[int, str]] = []
  3715. if _sn:
  3716. _check_keys += [
  3717. (printer_id, _sn),
  3718. (printer_id, f"{_sn}.3mf"),
  3719. (printer_id, f"{_sn}.gcode.3mf"),
  3720. ]
  3721. if _fn:
  3722. _base_fn = _fn.split("/")[-1] if "/" in _fn else _fn
  3723. _check_keys.append((printer_id, _base_fn))
  3724. _no_archive_base = _base_fn.replace(".gcode", "").replace(".3mf", "")
  3725. _check_keys += [
  3726. (printer_id, _no_archive_base),
  3727. (printer_id, f"{_no_archive_base}.3mf"),
  3728. ]
  3729. _has_expected = any(k in _expected_prints for k in _check_keys)
  3730. if not _has_expected:
  3731. # No expected print — truly external print (started from slicer/touchscreen)
  3732. logger.info("[CALLBACK] Skipping archive - auto_archive: False, no expected print")
  3733. if not notification_sent:
  3734. _no_archive_creator: int | None = None
  3735. for _key in _check_keys:
  3736. _expected_prints.pop(_key, None)
  3737. _expected_print_registered_at.pop(_key, None)
  3738. popped_creator = _expected_print_creators.pop(_key, None)
  3739. if _no_archive_creator is None:
  3740. _no_archive_creator = popped_creator
  3741. _creator_data = {"created_by_id": _no_archive_creator} if _no_archive_creator else None
  3742. await _send_print_start_notification(printer_id, data, _creator_data, logger)
  3743. return
  3744. else:
  3745. logger.info("[CALLBACK] auto_archive disabled but expected print found — promoting archive")
  3746. # Get the filename and subtask_name
  3747. filename = data.get("filename", "")
  3748. subtask_name = data.get("subtask_name", "")
  3749. # MQTT subtask_id uniquely identifies a print job on the printer. When
  3750. # present, it lets us match an archive across a backend restart (#972):
  3751. # same id → same print → resume the existing row instead of cancelling
  3752. # it and recreating from scratch (which loses started_at). Treat "0"
  3753. # and "" as absent — Bambu reports "0" for non-cloud / local prints.
  3754. raw_mqtt = data.get("raw_data") or {}
  3755. subtask_id = raw_mqtt.get("subtask_id")
  3756. if subtask_id is not None:
  3757. subtask_id = str(subtask_id).strip()
  3758. if subtask_id in ("", "0"):
  3759. subtask_id = None
  3760. logger.info("[CALLBACK] Print start detected - filename: %s, subtask: %s", filename, subtask_name)
  3761. # Skip the printer's own jobs — a calibration run is not a user's print.
  3762. # See is_internal_printer_job for what counts and why both fields are
  3763. # tested; the pressure-advance line reports as a subtask name with no
  3764. # /usr/ path, which the old prefix-only test here missed entirely.
  3765. #
  3766. # No notification either. The event describes the printer calibrating
  3767. # itself, so "Print started" is as wrong as the archive was, and the
  3768. # matching completion is suppressed in on_print_complete for the same
  3769. # reason.
  3770. if is_internal_printer_job(filename, subtask_name):
  3771. logger.info(
  3772. "[CALLBACK] Skipping archive — internal printer job detected: filename=%s, subtask=%s",
  3773. filename,
  3774. subtask_name,
  3775. )
  3776. return
  3777. if not filename and not subtask_name:
  3778. # Send notification without archive data (no filename)
  3779. logger.info("[CALLBACK] Skipping archive - no filename or subtask_name")
  3780. if not notification_sent:
  3781. await _send_print_start_notification(printer_id, data, logger=logger)
  3782. return
  3783. # Check if this is an expected print from reprint/scheduled
  3784. # Build list of possible keys to check
  3785. expected_keys = []
  3786. if subtask_name:
  3787. expected_keys.append((printer_id, subtask_name))
  3788. expected_keys.append((printer_id, f"{subtask_name}.3mf"))
  3789. expected_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
  3790. if filename:
  3791. fname = filename.split("/")[-1] if "/" in filename else filename
  3792. expected_keys.append((printer_id, fname))
  3793. # Strip extensions to match
  3794. base = fname.replace(".gcode", "").replace(".3mf", "")
  3795. expected_keys.append((printer_id, base))
  3796. expected_keys.append((printer_id, f"{base}.3mf"))
  3797. expected_archive_id = None
  3798. for key in expected_keys:
  3799. expected_archive_id = _expected_prints.pop(key, None)
  3800. _expected_print_registered_at.pop(key, None)
  3801. if expected_archive_id:
  3802. # Clean up other possible keys for this print
  3803. for other_key in expected_keys:
  3804. _expected_prints.pop(other_key, None)
  3805. _expected_print_registered_at.pop(other_key, None)
  3806. break
  3807. if expected_archive_id:
  3808. # This is a reprint/scheduled print - use existing archive, don't create new one
  3809. logger.info("Using expected archive %s for print (skipping duplicate)", expected_archive_id)
  3810. from backend.app.models.archive import PrintArchive
  3811. result = await db.execute(select(PrintArchive).where(PrintArchive.id == expected_archive_id))
  3812. archive = result.scalar_one_or_none()
  3813. if archive:
  3814. # Update archive status to printing
  3815. archive.status = "printing"
  3816. archive.started_at = datetime.now(timezone.utc)
  3817. # The previous run's answer is still on this row and the
  3818. # completion prompt is gated on ``user_verdict is None`` (#1898),
  3819. # so without a reset the second run inherits the first run's
  3820. # verdict: no prompt at all, and a green "good" badge on a run
  3821. # nobody ever judged.
  3822. if archive.confirm_requested:
  3823. archive.user_verdict = None
  3824. archive.user_verdict_source = None
  3825. archive.user_verdict_at = None
  3826. archive.confirm_token = None
  3827. archive.confirm_token_used_at = None
  3828. # Reprint of an archive reuses the source row. Without resetting
  3829. # ``timelapse_path`` _scan_for_timelapse_with_retries early-returns
  3830. # ("already has timelapse") and _capture_finish_photo_from_timelapse
  3831. # extracts the *original* print's last frame, which then ships in
  3832. # the completion notification (#1707). Clear the path so the
  3833. # scanner runs fresh; also unlink the old video file so reprints
  3834. # don't accumulate orphans in the archive directory. Photos list
  3835. # is left alone — accumulating one finish photo per run is fine.
  3836. # The print-start baseline (#2704) is stale for the same reason:
  3837. # it describes the printer before the previous run. The capture
  3838. # below overwrites it, but clear it here too so an early failure
  3839. # can't leave the scan diffing against the wrong snapshot.
  3840. archive.timelapse_baseline = None
  3841. stale_timelapse_relpath = archive.timelapse_path
  3842. if stale_timelapse_relpath:
  3843. archive.timelapse_path = None
  3844. try:
  3845. stale_path = app_settings.base_dir / stale_timelapse_relpath
  3846. if stale_path.is_file():
  3847. stale_path.unlink()
  3848. logger.info(
  3849. "Deleted stale timelapse %s on reprint of archive %s",
  3850. stale_timelapse_relpath,
  3851. expected_archive_id,
  3852. )
  3853. except OSError as e:
  3854. logger.warning(
  3855. "Failed to delete stale timelapse %s on reprint: %s",
  3856. stale_timelapse_relpath,
  3857. e,
  3858. )
  3859. # Persist a restart-stable id so a later restart resumes this
  3860. # archive by subtask_id instead of name-matching + duplicating
  3861. # it (#1485). The printer often hasn't echoed subtask_id back
  3862. # this soon after dispatch, so fall back to the id Bambuddy
  3863. # minted when it sent the print command. Scoped to this
  3864. # expected-print branch on purpose: an expected match means
  3865. # Bambuddy dispatched this exact print in this process, so the
  3866. # client's last-dispatch id genuinely belongs to it — using it
  3867. # for an externally-started print could mis-tag the archive.
  3868. effective_subtask_id = subtask_id
  3869. if not effective_subtask_id:
  3870. _client = printer_manager.get_client(printer_id)
  3871. _dispatched = getattr(_client, "last_dispatch_subtask_id", None) if _client else None
  3872. if _dispatched:
  3873. effective_subtask_id = str(_dispatched).strip() or None
  3874. # Update on first-set OR on reprint (the queue dispatcher mints
  3875. # a fresh subtask_id per dispatch in bambu_mqtt:3647). Skipping
  3876. # the rewrite for reprints leaves the archive holding the FIRST
  3877. # run's id; if MQTT then reconnects mid-print, the reconciler
  3878. # (#1542) compares the stale stored id against the printer's
  3879. # live id, sees a mismatch, and synthesises a bogus PRINT
  3880. # COMPLETE — exactly the false-positive "Print Stopped" reported
  3881. # in #1807. Inequality check preserves the noop-on-stable-push
  3882. # behaviour the earlier `not archive.subtask_id` guard provided.
  3883. if effective_subtask_id and archive.subtask_id != effective_subtask_id:
  3884. archive.subtask_id = effective_subtask_id
  3885. # #1403 follow-up: VP-queue archives are created with
  3886. # printer_id=None at queue-add time (we don't know which
  3887. # printer will run the job yet). When the print actually
  3888. # starts on a specific printer the expected-archive lookup
  3889. # used to skip this assignment, leaving printer_id=None
  3890. # forever — which then disables the "Scan for timelapse"
  3891. # button in ArchivesPage (gated on !archive.printer_id).
  3892. if archive.printer_id != printer_id:
  3893. archive.printer_id = printer_id
  3894. await db.commit()
  3895. # Track as active print
  3896. _active_prints[(printer_id, archive.filename)] = archive.id
  3897. if subtask_name:
  3898. _active_prints[(printer_id, f"{subtask_name}.3mf")] = archive.id
  3899. # Start timelapse session if external camera is enabled (#1353).
  3900. # Queue / VP-dispatched prints land here in the expected-archive
  3901. # branch and used to skip start_session entirely — frames were
  3902. # never captured and the post-print stitch silently returned None.
  3903. _maybe_start_layer_timelapse(printer, printer_id, archive.id)
  3904. # Inject ams_mapping into usage tracker session — the session was created
  3905. # before expected-print promotion, so it may have ams_mapping=None when
  3906. # the MQTT request topic subscription failed (common on P1S/A1).
  3907. _stored_map = _print_ams_mappings.get(expected_archive_id)
  3908. _stored_plate_id = _print_plate_ids.get(expected_archive_id)
  3909. if _stored_map or _stored_plate_id is not None:
  3910. try:
  3911. from backend.app.services.usage_tracker import _active_sessions
  3912. _ut_session = _active_sessions.get(printer_id)
  3913. if _ut_session and _stored_map and not _ut_session.ams_mapping:
  3914. _ut_session.ams_mapping = _stored_map
  3915. logger.info("[CALLBACK] Injected ams_mapping into usage tracker session: %s", _stored_map)
  3916. # plate_id injection covers direct-Print of plate N of a multi-plate
  3917. # 3MF — queue prints already capture it via the on_print_start queue
  3918. # lookup, but direct-Print never goes through the queue (#1697).
  3919. if _ut_session and _stored_plate_id is not None and _ut_session.plate_id is None:
  3920. _ut_session.plate_id = _stored_plate_id
  3921. logger.info("[CALLBACK] Injected plate_id into usage tracker session: %s", _stored_plate_id)
  3922. except Exception:
  3923. pass
  3924. # Set up energy tracking (#941: persist start on archive row)
  3925. await _record_energy_start(archive, printer_id, db, context="expected-print")
  3926. await ws_manager.send_archive_updated(
  3927. {
  3928. "id": archive.id,
  3929. "status": "printing",
  3930. }
  3931. )
  3932. # Send notification with archive data (reprint/scheduled)
  3933. if not notification_sent:
  3934. # Use archive's created_by_id; fall back to the creator registered via
  3935. # register_expected_print (handles library-file-based queue items where
  3936. # the freshly-created archive has no created_by_id yet).
  3937. # Pop ALL matching keys so no stale entries remain in the dict.
  3938. fallback_creator = None
  3939. for key in expected_keys:
  3940. popped = _expected_print_creators.pop(key, None)
  3941. if fallback_creator is None:
  3942. fallback_creator = popped
  3943. archive_data = {
  3944. "print_time_seconds": archive.print_time_seconds,
  3945. "created_by_id": archive.created_by_id or fallback_creator,
  3946. }
  3947. await _send_print_start_notification(printer_id, data, archive_data, logger)
  3948. # Extract printable objects from the archived 3MF file
  3949. _load_objects_from_archive(archive, printer_id, logger)
  3950. # Store Spoolman tracking data for per-filament usage reporting
  3951. try:
  3952. await _store_spoolman_print_data(
  3953. printer_id,
  3954. archive.id,
  3955. archive.file_path,
  3956. db,
  3957. printer_manager,
  3958. ams_mapping=_get_start_ams_mapping(data, archive.id),
  3959. plate_id=_get_start_plate_id(archive.id),
  3960. )
  3961. except Exception as e:
  3962. logger.warning("[SPOOLMAN] Failed to store tracking data: %s", e)
  3963. # Capture timelapse file baseline for snapshot-diff on completion
  3964. # (mirrors the new-archive branch). Queue / VP-dispatched prints
  3965. # hit this branch — without the baseline the completion-time scan
  3966. # falls into its "take baseline now" fallback, which snapshots
  3967. # AFTER the new MP4 already exists and never matches a diff
  3968. # (#1403 follow-up — see pwostran's 2026-05-18 support bundle).
  3969. await _capture_timelapse_baseline_at_start(printer, printer_id, logger, archive_id=archive.id)
  3970. return # Skip creating a new archive
  3971. # Check if there's already a "printing" archive for this printer/file
  3972. # This prevents duplicates when backend restarts during an active print
  3973. from backend.app.models.archive import PrintArchive
  3974. existing_archive: PrintArchive | None = None
  3975. # Preferred match: subtask_id equality. MQTT reports the same subtask_id
  3976. # across a backend restart for the same print, so this is the most
  3977. # reliable way to reattach. We also accept a previously stale-cancelled
  3978. # archive here so users upgrading mid-print get revived when the row
  3979. # their earlier Bambuddy version wrongly cancelled reappears (#972).
  3980. if subtask_id:
  3981. by_id = await db.execute(
  3982. select(PrintArchive)
  3983. .where(PrintArchive.printer_id == printer_id)
  3984. .where(PrintArchive.subtask_id == subtask_id)
  3985. .where(PrintArchive.status.in_(["printing", "cancelled"]))
  3986. .order_by(PrintArchive.created_at.desc())
  3987. .limit(1)
  3988. )
  3989. candidate = by_id.scalar_one_or_none()
  3990. if candidate and (candidate.status == "printing" or (candidate.failure_reason or "").startswith("Stale")):
  3991. existing_archive = candidate
  3992. # Fallback match: name-based lookup. Kept as-is for prints whose
  3993. # subtask_id is missing ("0" / local / non-cloud prints).
  3994. if existing_archive is None:
  3995. check_name = subtask_name or filename.split("/")[-1].replace(".gcode", "").replace(".3mf", "")
  3996. existing = await db.execute(
  3997. select(PrintArchive)
  3998. .where(PrintArchive.printer_id == printer_id)
  3999. .where(PrintArchive.status == "printing")
  4000. .where(
  4001. or_(
  4002. PrintArchive.print_name == check_name,
  4003. PrintArchive.filename.in_(
  4004. [
  4005. f"{check_name}.3mf",
  4006. f"{check_name}.gcode.3mf",
  4007. ]
  4008. ),
  4009. )
  4010. )
  4011. .order_by(PrintArchive.created_at.desc())
  4012. .limit(1)
  4013. )
  4014. existing_archive = existing.scalar_one_or_none()
  4015. if existing_archive:
  4016. # subtask_id match → always resume, regardless of age. Same print,
  4017. # just a backend restart. Revive if it was previously stale-cancelled.
  4018. subtask_match = bool(subtask_id and existing_archive.subtask_id == subtask_id)
  4019. if subtask_match:
  4020. if existing_archive.status == "cancelled":
  4021. logger.warning(
  4022. "Reviving stale-cancelled archive %s — matching subtask_id %s confirms same print (#972)",
  4023. existing_archive.id,
  4024. subtask_id,
  4025. )
  4026. existing_archive.status = "printing"
  4027. existing_archive.failure_reason = None
  4028. await db.commit()
  4029. else:
  4030. logger.info("Resuming archive %s on subtask_id match (%s)", existing_archive.id, subtask_id)
  4031. _active_prints[(printer_id, existing_archive.filename)] = existing_archive.id
  4032. if existing_archive.energy_start_kwh is None:
  4033. await _record_energy_start(existing_archive, printer_id, db, context="subtask-resume")
  4034. if not notification_sent:
  4035. archive_data = {
  4036. "print_time_seconds": existing_archive.print_time_seconds,
  4037. "created_by_id": existing_archive.created_by_id,
  4038. }
  4039. await _send_print_start_notification(printer_id, data, archive_data, logger)
  4040. _load_objects_from_archive(existing_archive, printer_id, logger)
  4041. return
  4042. # Name-match only (no subtask_id to anchor on): decide resume vs.
  4043. # stale from the printer's *current* progress, not wall-clock age.
  4044. # A genuinely long print used to trip a blind 4h cutoff and have its
  4045. # live archive cancelled + duplicated on every backend restart
  4046. # (#1485). If the printer reports real progress, this name-matched
  4047. # 'printing' archive IS that ongoing print — resume it whatever its
  4048. # age. Only treat it as a stale leftover when the printer clearly
  4049. # shows a different, freshly-started print: near-0% progress on an
  4050. # archive far too old to still be at 0%. Unknown progress (printer
  4051. # not connected) never cancels — resuming is the safe default.
  4052. archive_age = datetime.now(timezone.utc) - existing_archive.created_at.replace(tzinfo=timezone.utc)
  4053. live_status = printer_manager.get_status(printer_id)
  4054. live_progress = getattr(live_status, "progress", None) if live_status else None
  4055. looks_stale = (
  4056. live_progress is not None and live_progress < 1.0 and archive_age.total_seconds() > 2 * 60 * 60
  4057. )
  4058. if looks_stale:
  4059. logger.warning(
  4060. f"Found stale 'printing' archive {existing_archive.id} (age: {archive_age}, "
  4061. f"printer progress {live_progress:.0f}%) — marking cancelled and creating new archive"
  4062. )
  4063. existing_archive.status = "cancelled"
  4064. # Canonical key, not a sentence (issue #2974). "No status update
  4065. # received" is what both stale paths actually observed; which of
  4066. # the two it was is already carried by ``status`` -- cancelled
  4067. # here, the reconciled outcome at the reconnect site -- so one
  4068. # key loses no information and gives the Statistics breakdown a
  4069. # single bucket instead of two untranslatable prose strings.
  4070. existing_archive.failure_reason = "noStatusUpdate"
  4071. await db.commit()
  4072. # Fall through to create new archive (don't return)
  4073. else:
  4074. logger.info(
  4075. f"Skipping duplicate - already have printing archive {existing_archive.id} for {check_name}"
  4076. )
  4077. # Track this as the active print
  4078. _active_prints[(printer_id, existing_archive.filename)] = existing_archive.id
  4079. # Attach subtask_id retroactively so future restarts can resume.
  4080. # Compare for inequality (not "is empty") to also pick up reprint
  4081. # dispatches that mint a fresh id — see #1807 for the bogus
  4082. # "Print Stopped" the strict-empty guard caused on reconnect.
  4083. if subtask_id and existing_archive.subtask_id != subtask_id:
  4084. existing_archive.subtask_id = subtask_id
  4085. await db.commit()
  4086. # Also set up energy tracking if not already tracked (#941: persisted column)
  4087. if existing_archive.energy_start_kwh is None:
  4088. await _record_energy_start(existing_archive, printer_id, db, context="existing-printing")
  4089. # Send notification with archive data (existing archive)
  4090. if not notification_sent:
  4091. archive_data = {
  4092. "print_time_seconds": existing_archive.print_time_seconds,
  4093. "created_by_id": existing_archive.created_by_id,
  4094. }
  4095. await _send_print_start_notification(printer_id, data, archive_data, logger)
  4096. # Extract printable objects from the archived 3MF file
  4097. _load_objects_from_archive(existing_archive, printer_id, logger)
  4098. return
  4099. # Build list of possible 3MF filenames to try
  4100. possible_names = []
  4101. # Bambu printers typically store files as "Name.gcode.3mf"
  4102. # The subtask_name is usually the best source for the filename
  4103. if subtask_name:
  4104. # Try common Bambu naming patterns
  4105. possible_names.append(f"{subtask_name}.gcode.3mf")
  4106. possible_names.append(f"{subtask_name}.3mf")
  4107. # Try original filename with .3mf extension
  4108. if filename:
  4109. # Extract just the filename part, not the full path
  4110. fname = filename.split("/")[-1] if "/" in filename else filename
  4111. if fname.endswith(".3mf"):
  4112. possible_names.append(fname)
  4113. elif fname.endswith(".gcode"):
  4114. base = fname.rsplit(".", 1)[0]
  4115. possible_names.append(f"{base}.gcode.3mf")
  4116. possible_names.append(f"{base}.3mf")
  4117. else:
  4118. possible_names.append(f"{fname}.gcode.3mf")
  4119. possible_names.append(f"{fname}.3mf")
  4120. # Also try with spaces converted to underscores (Bambu Studio may normalize filenames)
  4121. space_variants = []
  4122. for name in possible_names:
  4123. if " " in name:
  4124. space_variants.append(name.replace(" ", "_"))
  4125. possible_names.extend(space_variants)
  4126. # Remove duplicates while preserving order
  4127. seen = set()
  4128. possible_names = [x for x in possible_names if not (x in seen or seen.add(x))]
  4129. logger.info("Trying filenames: %s", possible_names)
  4130. # Release the pooled DB connection before the 3MF FTP download. Reaching
  4131. # here means none of the expected-/existing-archive write branches ran
  4132. # (they all return earlier) — only SELECTs have executed on this path, so
  4133. # this commit persists nothing; it ends the read transaction so the
  4134. # connection returns to the pool during the download. That download tries
  4135. # up to five remote paths per candidate filename with retry/backoff and
  4136. # can run for minutes under FTP contention; holding the session across it
  4137. # pinned one pooled connection idle-in-transaction (issue #2572). No DB
  4138. # work runs during the download — the new-archive writes below re-acquire
  4139. # a fresh connection, and expire_on_commit=False keeps printer.* readable.
  4140. await db.commit()
  4141. # Try to find and download the 3MF file
  4142. temp_path = None
  4143. downloaded_filename = None
  4144. # Cache check: cover endpoint may have already pulled this 3MF during
  4145. # the print (frontend opens the card and shows the thumbnail) — reuse
  4146. # that file instead of re-downloading 36MB over the same FTP link that
  4147. # just served it (#972). The cache keys on a normalized filename so
  4148. # variants like "X", "X.3mf", "X.gcode.3mf" all collapse to one entry.
  4149. for try_filename in possible_names:
  4150. if not try_filename.endswith(".3mf"):
  4151. continue
  4152. cached = get_cached_3mf(printer_id, try_filename)
  4153. if cached:
  4154. logger.info("Reusing cached 3MF from %s (avoided duplicate FTP)", cached)
  4155. temp_path = cached
  4156. downloaded_filename = try_filename
  4157. break
  4158. # Does this printer keep the sliced file somewhere FTPS can reach? On
  4159. # H2-series and P2S the answer is routinely no — the file stays on
  4160. # internal eMMC and port 990 only ever serves external storage — and
  4161. # then the whole sweep below (six filenames x five directories x four
  4162. # retries, then the directory walk) is ~110 connections that cannot
  4163. # succeed. Skip it and say why (#2780).
  4164. storage = print_file_reachable_over_ftp(printer_manager.get_status(printer_id))
  4165. # Set when a lookup is abandoned because the printer's FTPS cool-off is
  4166. # running rather than because the file is somewhere unreachable. The
  4167. # distinction is the whole of #2957: one is permanent, the other clears
  4168. # in minutes with the file still sitting on the printer.
  4169. blocked_by_ftps_cooloff = False
  4170. # Set when a probe reached the printer and still came back without the
  4171. # file -- a timeout mid-transfer, a refused connection, anything that is
  4172. # not a clean "not here". A 550 raises FileNotOnPrinterError and is
  4173. # caught by name below, so a file that genuinely is not on the card
  4174. # leaves this False and schedules nothing. Anything else means the
  4175. # transfer, not the file, is what failed, and that does not last (#3063).
  4176. ftp_transfer_failed = False
  4177. # The print's name, for a fallback archive whose `subtask_name` the
  4178. # plate guard below had to disown. Display only, and deliberately kept
  4179. # apart from `subtask_name`: that variable is what every file lookup
  4180. # here is built from, and once a name has been shown to fetch another
  4181. # plate's 3MF it must not key `_active_prints` either, or the cover
  4182. # endpoint hands the same contradicted file to
  4183. # `_recover_fallback_archive` and fills the row in with it (#3126).
  4184. display_name_after_plate_reject: str | None = None
  4185. # Get FTP retry settings
  4186. ftp_retry_enabled, ftp_retry_count, ftp_retry_delay, ftp_timeout = await get_ftp_retry_settings()
  4187. # ...but "the printer put it on eMMC" is where it went, not whether we
  4188. # can read it. An H2D with a card in mirrors the job to /cache and
  4189. # serves it happily, and skipping on the URL alone cost that reporter
  4190. # every archive for two days (#2856). So ask the printer instead of
  4191. # guessing: the dispatch named the exact file, which is one connection
  4192. # walking five paths rather than the sweep's ~110. Only when the probe
  4193. # comes back empty does the verdict's reason stand.
  4194. if not storage.reachable and not downloaded_filename and storage.probe_filename:
  4195. if ftps_handshake_blocked(printer.ip_address):
  4196. # Deliberately NOT recorded as a cool-off give-up. This branch
  4197. # only runs on an unreachable verdict, and that verdict is the
  4198. # honest, permanent reason the archive is empty — the probe was
  4199. # a long shot on top of it. Blaming the cool-off here would
  4200. # schedule a retry for a file sitting on internal eMMC, which is
  4201. # the sweep #2780 removed (#2957).
  4202. logger.debug(
  4203. "Not probing for %s on printer %s: its file service is not answering over TLS",
  4204. storage.probe_filename,
  4205. printer_id,
  4206. )
  4207. else:
  4208. probe_path = app_settings.archive_dir / "temp" / storage.probe_filename
  4209. probe_path.parent.mkdir(parents=True, exist_ok=True)
  4210. try:
  4211. probe_hit = await download_file_try_paths_async(
  4212. printer.ip_address,
  4213. printer.access_code,
  4214. ftp_probe_paths(storage.probe_filename),
  4215. probe_path,
  4216. socket_timeout=ftp_timeout,
  4217. printer_model=printer.model,
  4218. )
  4219. except Exception as e:
  4220. logger.debug("3MF probe for %s failed: %s", storage.probe_filename, e)
  4221. probe_hit = False
  4222. if probe_hit:
  4223. downloaded_filename = storage.probe_filename
  4224. temp_path = probe_path
  4225. cache_3mf_download(printer_id, downloaded_filename, probe_path)
  4226. # Naming the path, not just the file: a printer that keeps
  4227. # uploads around for weeks can serve a same-named copy of an
  4228. # earlier slice, and without the directory in the log that
  4229. # mismatch is invisible rather than merely rare (#1820).
  4230. logger.info(
  4231. "Found %s at %s over FTPS for printer %s even though the printer reported %s",
  4232. downloaded_filename,
  4233. probe_hit,
  4234. printer_id,
  4235. storage.reason,
  4236. )
  4237. if not storage.reachable and not downloaded_filename:
  4238. # Same opening words whether or not a probe ran, because that is
  4239. # the phrase support asks people to grep for — only the tail says
  4240. # which of the two happened.
  4241. logger.info(
  4242. "Skipping the 3MF lookup for printer %s: %s — %s",
  4243. printer_id,
  4244. storage.reason,
  4245. "no copy of it on external storage either"
  4246. if storage.probe_filename
  4247. else "the print file is not on storage Bambuddy can read over FTPS, so no path would find it",
  4248. )
  4249. for try_filename in possible_names if not downloaded_filename and storage.reachable else []:
  4250. if not try_filename.endswith(".3mf"):
  4251. continue
  4252. # Root (/) is where BambuStudio/OrcaSlicer uploads land on A1/P1-series
  4253. # printers, so try it first — deferring it to last cost #972's reporter
  4254. # ~48 minutes of retries on /cache//model//data//data/Metadata before
  4255. # landing on the path that actually had the file.
  4256. remote_paths = [
  4257. f"/{try_filename}",
  4258. f"/cache/{try_filename}",
  4259. f"/model/{try_filename}",
  4260. f"/data/{try_filename}",
  4261. f"/data/Metadata/{try_filename}",
  4262. ]
  4263. temp_path = app_settings.archive_dir / "temp" / try_filename
  4264. temp_path.parent.mkdir(parents=True, exist_ok=True)
  4265. for remote_path in remote_paths:
  4266. if ftps_handshake_blocked(printer.ip_address):
  4267. # The printer's FTPS service is not completing a TLS
  4268. # handshake, so it has no path we could reach — walking the
  4269. # remaining candidates only re-runs the same failure
  4270. # (#2780). Fall through to the no-3MF archive now.
  4271. #
  4272. # Remember *why*, though. This is the one give-up that is
  4273. # temporary: the cool-off clears in minutes and the file was
  4274. # on the printer the whole time. The fallback archive is
  4275. # stamped with it so a retry can be scheduled, and so the
  4276. # Archives banner stops blaming storage (#2957).
  4277. blocked_by_ftps_cooloff = True
  4278. logger.warning(
  4279. "Giving up on the 3MF for printer %s: its file service is not answering over TLS",
  4280. printer_id,
  4281. )
  4282. break
  4283. logger.debug("Trying FTP download: %s", remote_path)
  4284. try:
  4285. if ftp_retry_enabled:
  4286. downloaded = await with_ftp_retry(
  4287. download_file_async,
  4288. printer.ip_address,
  4289. printer.access_code,
  4290. remote_path,
  4291. temp_path,
  4292. timeout=ftp_timeout,
  4293. socket_timeout=ftp_timeout,
  4294. printer_model=printer.model,
  4295. max_retries=ftp_retry_count,
  4296. retry_delay=ftp_retry_delay,
  4297. operation_name=f"Download 3MF from {remote_path}",
  4298. cooloff_ip=printer.ip_address,
  4299. non_retry_exceptions=(FileNotOnPrinterError,),
  4300. )
  4301. else:
  4302. downloaded = await download_file_async(
  4303. printer.ip_address,
  4304. printer.access_code,
  4305. remote_path,
  4306. temp_path,
  4307. timeout=ftp_timeout,
  4308. socket_timeout=ftp_timeout,
  4309. printer_model=printer.model,
  4310. )
  4311. if downloaded:
  4312. downloaded_filename = try_filename
  4313. logger.info("Downloaded: %s", remote_path)
  4314. # Populate shared cache so the cover endpoint (if it
  4315. # runs next) doesn't refetch the same 36MB over FTP.
  4316. cache_3mf_download(printer_id, try_filename, temp_path)
  4317. break
  4318. # with_ftp_retry returns None once it has spent its budget,
  4319. # and download_file_async returns False on a timeout, so an
  4320. # exhausted transfer arrives here rather than as an
  4321. # exception (#3063).
  4322. ftp_transfer_failed = True
  4323. except FileNotOnPrinterError:
  4324. # 550 — file isn't at this path. Advance to next candidate
  4325. # without burning the retry budget.
  4326. logger.debug("3MF not at %s (550), trying next path", remote_path)
  4327. except Exception as e:
  4328. ftp_transfer_failed = True
  4329. logger.debug("FTP download failed for %s: %s", remote_path, e)
  4330. if downloaded_filename or ftps_handshake_blocked(printer.ip_address):
  4331. break
  4332. # If still not found, try listing directories to find matching file
  4333. # Different printer models use different directory structures. Skipped
  4334. # when the printer's FTPS handshake is failing — the directory walk is
  4335. # five more connections that cannot get further than the download did.
  4336. if (
  4337. not downloaded_filename
  4338. and storage.reachable
  4339. and (filename or subtask_name)
  4340. and not ftps_handshake_blocked(printer.ip_address)
  4341. ):
  4342. search_term = (subtask_name or filename).lower().replace(".gcode", "").replace(".3mf", "")
  4343. logger.info("Direct FTP download failed, searching directories for '%s'", search_term)
  4344. search_dirs = ["/cache", "/model", "/data", "/data/Metadata", "/"]
  4345. for search_dir in search_dirs:
  4346. if downloaded_filename:
  4347. break
  4348. try:
  4349. dir_files = await list_files_async(
  4350. printer.ip_address, printer.access_code, search_dir, printer_model=printer.model
  4351. )
  4352. threemf_files = [f.get("name") for f in dir_files if f.get("name", "").endswith(".3mf")]
  4353. if threemf_files:
  4354. logger.info(
  4355. f"Found {len(threemf_files)} 3MF files in {search_dir}: {threemf_files[:5]}{'...' if len(threemf_files) > 5 else ''}"
  4356. )
  4357. for f in dir_files:
  4358. if f.get("is_directory"):
  4359. continue
  4360. fname = f.get("name", "")
  4361. # Normalize both for comparison (spaces and underscores are equivalent)
  4362. fname_normalized = fname.lower().replace(" ", "_")
  4363. search_normalized = search_term.replace(" ", "_")
  4364. if fname.endswith(".3mf") and search_normalized in fname_normalized:
  4365. logger.info("Found matching file in %s: %s", search_dir, fname)
  4366. temp_path = app_settings.archive_dir / "temp" / fname
  4367. temp_path.parent.mkdir(parents=True, exist_ok=True)
  4368. remote_full_path = posixpath.join(search_dir, fname)
  4369. if ftp_retry_enabled:
  4370. downloaded = await with_ftp_retry(
  4371. download_file_async,
  4372. printer.ip_address,
  4373. printer.access_code,
  4374. remote_full_path,
  4375. temp_path,
  4376. timeout=ftp_timeout,
  4377. socket_timeout=ftp_timeout,
  4378. printer_model=printer.model,
  4379. max_retries=ftp_retry_count,
  4380. retry_delay=ftp_retry_delay,
  4381. operation_name=f"Download 3MF from {remote_full_path}",
  4382. cooloff_ip=printer.ip_address,
  4383. )
  4384. else:
  4385. downloaded = await download_file_async(
  4386. printer.ip_address,
  4387. printer.access_code,
  4388. remote_full_path,
  4389. temp_path,
  4390. timeout=ftp_timeout,
  4391. socket_timeout=ftp_timeout,
  4392. printer_model=printer.model,
  4393. )
  4394. if downloaded:
  4395. downloaded_filename = fname
  4396. logger.info("Found and downloaded from %s: %s", search_dir, fname)
  4397. cache_3mf_download(printer_id, fname, temp_path)
  4398. break
  4399. # The listing named the file, so it is on the card;
  4400. # only the transfer failed (#3063).
  4401. ftp_transfer_failed = True
  4402. except Exception as e:
  4403. logger.debug("Failed to list %s: %s", search_dir, e)
  4404. # Validate the downloaded 3MF actually matches the plate that's running
  4405. # (#1204): subtask_name lags across consecutive plates of the same model,
  4406. # so the first FTP candidate (built from subtask_name) can land on the
  4407. # previous plate's still-resident upload. Cross-check the slice_info
  4408. # plate index against the plate parsed from gcode_file (always fresh —
  4409. # it's the field whose change triggered this callback).
  4410. if downloaded_filename and temp_path:
  4411. expected_plate = parse_plate_id(filename)
  4412. actual_plate = peek_plate_index_in_3mf(temp_path) if expected_plate is not None else None
  4413. if expected_plate is not None and actual_plate is not None and actual_plate != expected_plate:
  4414. logger.warning(
  4415. "[CALLBACK] 3MF plate mismatch: downloaded %s reports plate %s but printer is "
  4416. "running plate %s — subtask_name=%r appears stale, retrying with corrected name",
  4417. downloaded_filename,
  4418. actual_plate,
  4419. expected_plate,
  4420. subtask_name,
  4421. )
  4422. corrected_subtask = swap_plate_suffix(subtask_name, expected_plate)
  4423. retry_succeeded = False
  4424. if corrected_subtask and corrected_subtask != subtask_name:
  4425. for try_filename in (f"{corrected_subtask}.gcode.3mf", f"{corrected_subtask}.3mf"):
  4426. retry_temp_path = app_settings.archive_dir / "temp" / try_filename
  4427. retry_temp_path.parent.mkdir(parents=True, exist_ok=True)
  4428. for remote_path in (
  4429. f"/{try_filename}",
  4430. f"/cache/{try_filename}",
  4431. f"/model/{try_filename}",
  4432. f"/data/{try_filename}",
  4433. f"/data/Metadata/{try_filename}",
  4434. ):
  4435. try:
  4436. if ftp_retry_enabled:
  4437. downloaded = await with_ftp_retry(
  4438. download_file_async,
  4439. printer.ip_address,
  4440. printer.access_code,
  4441. remote_path,
  4442. retry_temp_path,
  4443. timeout=ftp_timeout,
  4444. socket_timeout=ftp_timeout,
  4445. printer_model=printer.model,
  4446. max_retries=ftp_retry_count,
  4447. retry_delay=ftp_retry_delay,
  4448. operation_name=f"Re-download 3MF from {remote_path}",
  4449. cooloff_ip=printer.ip_address,
  4450. non_retry_exceptions=(FileNotOnPrinterError,),
  4451. )
  4452. else:
  4453. downloaded = await download_file_async(
  4454. printer.ip_address,
  4455. printer.access_code,
  4456. remote_path,
  4457. retry_temp_path,
  4458. timeout=ftp_timeout,
  4459. socket_timeout=ftp_timeout,
  4460. printer_model=printer.model,
  4461. )
  4462. if downloaded and peek_plate_index_in_3mf(retry_temp_path) == expected_plate:
  4463. logger.info(
  4464. "[CALLBACK] Re-download succeeded with corrected name %s "
  4465. "(plate %s) — replacing wrong file",
  4466. try_filename,
  4467. expected_plate,
  4468. )
  4469. try:
  4470. temp_path.unlink(missing_ok=True)
  4471. except OSError:
  4472. pass
  4473. temp_path = retry_temp_path
  4474. downloaded_filename = try_filename
  4475. subtask_name = corrected_subtask
  4476. cache_3mf_download(printer_id, try_filename, temp_path)
  4477. retry_succeeded = True
  4478. break
  4479. elif downloaded:
  4480. # Wrong plate again — discard and keep trying
  4481. try:
  4482. retry_temp_path.unlink(missing_ok=True)
  4483. except OSError:
  4484. pass
  4485. except FileNotOnPrinterError:
  4486. continue
  4487. except Exception as e:
  4488. logger.debug("Re-download failed for %s: %s", remote_path, e)
  4489. if retry_succeeded:
  4490. break
  4491. # If the retry didn't find a matching file, drop the wrong 3MF
  4492. # so the no-3MF fallback below creates an archive whose name
  4493. # at least reflects the right plate.
  4494. if not retry_succeeded:
  4495. logger.warning(
  4496. "[CALLBACK] Could not re-download correct plate %s — falling back to no-3MF archive",
  4497. expected_plate,
  4498. )
  4499. try:
  4500. temp_path.unlink(missing_ok=True)
  4501. except OSError:
  4502. pass
  4503. temp_path = None
  4504. downloaded_filename = None
  4505. # Whatever the sweep's transport did earlier, it is not why
  4506. # this archive ends up empty: a 3MF downloaded fine, it was
  4507. # just the wrong plate. Retrying would re-fetch that same
  4508. # contradicted file under the same stale names and hand it
  4509. # to _recover_fallback_archive, which checks that a
  4510. # candidate is a readable 3MF but not which plate it is --
  4511. # so the row would be filled in with another plate's
  4512. # filament and cost, the exact swap #2957 removed (#3063).
  4513. ftp_transfer_failed = False
  4514. # Disown the name for *lookups*: it has just been shown to
  4515. # fetch another plate's 3MF, and it keys `_active_prints`
  4516. # below, where the cover endpoint's own download of that
  4517. # same name would find this archive and fill it in with the
  4518. # file we are discarding here.
  4519. #
  4520. # Keep it for the *title*, which is a separate question.
  4521. # ``swap_plate_suffix`` returns None both for a name that
  4522. # carries no "- Plate N" / "_plate_N" suffix and for no
  4523. # name at all, and those are not the same situation: a name
  4524. # without a suffix holds no stale plate number to be wrong
  4525. # about. Blanking both uses at once dropped the project
  4526. # name too, and the row fell through to the gcode_file path
  4527. # titled "plate_1" though the real name was in hand.
  4528. # #1204's own premise is consecutive plates *of the same
  4529. # model*, so the project part is right either way (#3126).
  4530. display_name_after_plate_reject = corrected_subtask or subtask_name or None
  4531. subtask_name = corrected_subtask or ""
  4532. if not downloaded_filename or not temp_path:
  4533. logger.warning("Could not find 3MF file for print: %s", filename or subtask_name)
  4534. # Create a fallback archive without 3MF data so the print is still tracked
  4535. # This commonly happens with P1S/A1 printers where FTP has file size limitations
  4536. try:
  4537. from backend.app.models.archive import PrintArchive
  4538. # Why the card is empty. The two temporary causes outrank the
  4539. # storage verdict because they say the sweep never got a fair
  4540. # answer: a cool-off skipped it at the transport, and a failed
  4541. # transfer reached the printer but never finished. Either way
  4542. # the file is still on the card, so reporting where the printer
  4543. # files its jobs would describe a setting that is not the
  4544. # problem (#2957, #3063).
  4545. if blocked_by_ftps_cooloff:
  4546. no_3mf_reason = REASON_FTPS_COOLOFF
  4547. elif storage.reachable and ftp_transfer_failed:
  4548. no_3mf_reason = REASON_FTP_TRANSFER_FAILED
  4549. else:
  4550. no_3mf_reason = storage.reason
  4551. # Derive print name from subtask_name or filename. The
  4552. # plate guard's disowned name comes second: it is a real name
  4553. # for a real print, and only the gcode_file path is left
  4554. # otherwise -- which titles the row "plate_1" (#3126).
  4555. print_name = subtask_name or display_name_after_plate_reject or filename
  4556. if print_name:
  4557. # Clean up the name (remove extensions, path parts)
  4558. print_name = print_name.split("/")[-1]
  4559. print_name = print_name.replace(".gcode.3mf", "").replace(".gcode", "").replace(".3mf", "")
  4560. else:
  4561. print_name = "Unknown Print"
  4562. # Recover estimated print time from MQTT (best-effort for notifications)
  4563. fallback_print_time = None
  4564. mqtt_remaining = data.get("remaining_time")
  4565. if mqtt_remaining and isinstance(mqtt_remaining, (int, float)) and mqtt_remaining > 0:
  4566. fallback_print_time = int(mqtt_remaining)
  4567. if fallback_print_time is None:
  4568. mc_remaining = (data.get("raw_data") or {}).get("mc_remaining_time")
  4569. if mc_remaining and isinstance(mc_remaining, (int, float)) and mc_remaining > 0:
  4570. fallback_print_time = int(mc_remaining * 60)
  4571. # Best-effort filament metadata from MQTT — see
  4572. # _extract_filament_data_from_mqtt. Without this the fallback
  4573. # archive's filament fields stayed NULL even though the AMS
  4574. # state at print start was sitting right there in `data`.
  4575. # The slicer's ams_mapping (when present) narrows the result
  4576. # to slots actually used by the print (#1533).
  4577. mqtt_filament_meta = _extract_filament_data_from_mqtt(data, _get_start_ams_mapping(data, None))
  4578. # Create minimal archive entry
  4579. fallback_archive = PrintArchive(
  4580. printer_id=printer_id,
  4581. filename=filename or f"{print_name}.3mf",
  4582. file_path="", # Empty - no 3MF file available
  4583. file_size=0,
  4584. print_name=print_name,
  4585. print_time_seconds=fallback_print_time,
  4586. status="printing",
  4587. started_at=datetime.now(timezone.utc),
  4588. subtask_id=subtask_id,
  4589. confirm_requested=await _ask_outcome_for_external_print(db, printer_id, subtask_name),
  4590. filament_type=mqtt_filament_meta.get("filament_type"),
  4591. filament_color=mqtt_filament_meta.get("filament_color"),
  4592. extra_data={
  4593. "no_3mf_available": True,
  4594. # Why the card is empty, when we know -- see above. The
  4595. # banner reads this to stop telling H2/P2 owners to
  4596. # switch on a setting that is already on and would not
  4597. # have helped (#2780).
  4598. "no_3mf_reason": no_3mf_reason,
  4599. "original_subtask": subtask_name or display_name_after_plate_reject or "",
  4600. "_print_data": data,
  4601. },
  4602. )
  4603. db.add(fallback_archive)
  4604. await db.commit()
  4605. await db.refresh(fallback_archive)
  4606. logger.info("Created fallback archive %s for %s (no 3MF available)", fallback_archive.id, print_name)
  4607. _maybe_start_layer_timelapse(printer, printer_id, fallback_archive.id)
  4608. # Track as active print
  4609. _active_prints[(printer_id, fallback_archive.filename)] = fallback_archive.id
  4610. if filename:
  4611. _active_prints[(printer_id, filename)] = fallback_archive.id
  4612. if subtask_name:
  4613. _active_prints[(printer_id, f"{subtask_name}.3mf")] = fallback_archive.id
  4614. _active_prints[(printer_id, subtask_name)] = fallback_archive.id
  4615. # Record starting energy if smart plug available (#941: persisted column)
  4616. await _record_energy_start(fallback_archive, printer_id, db, context="fallback")
  4617. # Send WebSocket notification
  4618. await ws_manager.send_archive_created(
  4619. {
  4620. "id": fallback_archive.id,
  4621. "printer_id": fallback_archive.printer_id,
  4622. "filename": fallback_archive.filename,
  4623. "print_name": fallback_archive.print_name,
  4624. "status": fallback_archive.status,
  4625. }
  4626. )
  4627. # MQTT relay - publish archive created
  4628. try:
  4629. await mqtt_relay.on_archive_created(
  4630. archive_id=fallback_archive.id,
  4631. print_name=fallback_archive.print_name,
  4632. printer_name=printer.name,
  4633. status=fallback_archive.status,
  4634. )
  4635. except Exception:
  4636. pass # Don't fail if MQTT fails
  4637. # Store Spoolman tracking data (may not work for fallback since no 3MF)
  4638. try:
  4639. await _store_spoolman_print_data(
  4640. printer_id,
  4641. fallback_archive.id,
  4642. fallback_archive.file_path,
  4643. db,
  4644. printer_manager,
  4645. ams_mapping=_get_start_ams_mapping(data, fallback_archive.id),
  4646. plate_id=_get_start_plate_id(fallback_archive.id),
  4647. )
  4648. except Exception as e:
  4649. logger.debug("[SPOOLMAN] Could not store tracking for fallback archive: %s", e)
  4650. # Both temporary give-ups are worth coming back for, and for
  4651. # the same reason: the file is on the printer and the last look
  4652. # failed at the transport rather than finding nothing. One waits
  4653. # out the handshake block (#2957), the other waits for the
  4654. # printer to stop being busy (#3063). Deliberately not scheduled
  4655. # for a storage verdict: a file on internal eMMC will not appear
  4656. # at any FTPS path however long we wait, and retrying it is
  4657. # exactly the sweep #2780 removed.
  4658. if no_3mf_reason in (REASON_FTPS_COOLOFF, REASON_FTP_TRANSFER_FAILED) and possible_names:
  4659. # `possible_names`, not the raw MQTT strings: it is the exact
  4660. # list this flow just tried, already stripped of any path
  4661. # (`filename` arrives as "/data/Metadata/plate_1.gcode" on
  4662. # some firmware) and deduped.
  4663. _schedule_fallback_3mf_retry(
  4664. printer_id=printer_id,
  4665. archive_id=fallback_archive.id,
  4666. filenames=list(possible_names),
  4667. reason=no_3mf_reason,
  4668. )
  4669. # Send notification without archive data (file not found)
  4670. if not notification_sent:
  4671. await _send_print_start_notification(printer_id, data, logger=logger)
  4672. # The same baseline the other two on_print_start branches take
  4673. # (#2704), and last for the same reason they are: it lists the
  4674. # printer's timelapse directory, so a slow card must not delay
  4675. # the _active_prints registration, the energy reading, the
  4676. # archive-created event or the start notification above it.
  4677. #
  4678. # This branch never took one, so every no-3MF archive reached
  4679. # completion with no baseline in memory and none on the row, and
  4680. # the completion scan fell into its "snapshot now" fallback --
  4681. # which runs after the printer has written the video, so the new
  4682. # file landed inside the baseline and no diff ever matched
  4683. # (#2957 follow-up).
  4684. #
  4685. # Skipped when the FTPS cool-off is what produced this fallback:
  4686. # the listing needs the same connection that just failed, so it
  4687. # could only record that the card was unreadable. The scan
  4688. # handles that case by refusing to choose between candidates.
  4689. if not blocked_by_ftps_cooloff:
  4690. await _capture_timelapse_baseline_at_start(
  4691. printer, printer_id, logger, archive_id=fallback_archive.id
  4692. )
  4693. return
  4694. except Exception as e:
  4695. logger.error("Failed to create fallback archive: %s", e)
  4696. # Send notification without archive data (file not found)
  4697. if not notification_sent:
  4698. await _send_print_start_notification(printer_id, data, logger=logger)
  4699. return
  4700. try:
  4701. # Archive the file with status "printing"
  4702. service = ArchiveService(db)
  4703. archive = await service.archive_print(
  4704. printer_id=printer_id,
  4705. source_file=temp_path,
  4706. print_data={**data, "status": "printing"},
  4707. subtask_id=subtask_id,
  4708. )
  4709. if archive:
  4710. # Ask-for-outcome for a print Bambuddy did not dispatch (#1898).
  4711. # Set on the row rather than passed to archive_print, which also
  4712. # serves the queue dispatcher — there the queue item decides.
  4713. # Guarded because this branch has no ``except``: an unhandled
  4714. # write error would take the _active_prints registration, the
  4715. # start notification, the energy reading and the timelapse
  4716. # baseline below it with it, and a missing prompt is by far the
  4717. # cheaper failure.
  4718. archive_id = archive.id
  4719. try:
  4720. if await _ask_outcome_for_external_print(db, printer_id, subtask_name):
  4721. archive.confirm_requested = True
  4722. await db.commit()
  4723. except Exception as e:
  4724. logger.warning("Could not flag archive %s for the outcome prompt: %s", archive_id, e)
  4725. # The rollback expires every loaded object, and on an async
  4726. # session reading one afterwards raises instead of
  4727. # reloading, so the two this branch goes on to use are
  4728. # fetched again. The archive itself was committed by
  4729. # archive_print; only the flag is lost.
  4730. try:
  4731. await db.rollback()
  4732. archive = await db.get(PrintArchive, archive_id)
  4733. printer = await db.get(Printer, printer_id)
  4734. except Exception as reload_error:
  4735. logger.warning(
  4736. "Could not reload archive %s after the failed flag write: %s", archive_id, reload_error
  4737. )
  4738. # Track this active print (use both original filename and downloaded filename)
  4739. _active_prints[(printer_id, downloaded_filename)] = archive.id
  4740. if filename and filename != downloaded_filename:
  4741. _active_prints[(printer_id, filename)] = archive.id
  4742. if subtask_name:
  4743. _active_prints[(printer_id, f"{subtask_name}.3mf")] = archive.id
  4744. logger.info("Created archive %s for %s", archive.id, downloaded_filename)
  4745. _maybe_start_layer_timelapse(printer, printer_id, archive.id)
  4746. # Record starting energy from smart plug if available (#941: persisted column)
  4747. await _record_energy_start(archive, printer_id, db, context="auto-archive")
  4748. await ws_manager.send_archive_created(
  4749. {
  4750. "id": archive.id,
  4751. "printer_id": archive.printer_id,
  4752. "filename": archive.filename,
  4753. "print_name": archive.print_name,
  4754. "status": archive.status,
  4755. }
  4756. )
  4757. # MQTT relay - publish archive created
  4758. try:
  4759. await mqtt_relay.on_archive_created(
  4760. archive_id=archive.id,
  4761. print_name=archive.print_name,
  4762. printer_name=printer.name,
  4763. status=archive.status,
  4764. )
  4765. except Exception:
  4766. pass # Don't fail if MQTT fails
  4767. # Send notification with archive data (new archive created)
  4768. if not notification_sent:
  4769. archive_data = {
  4770. "print_time_seconds": archive.print_time_seconds,
  4771. "created_by_id": archive.created_by_id,
  4772. }
  4773. await _send_print_start_notification(printer_id, data, archive_data, logger)
  4774. # Extract printable objects for skip object functionality
  4775. try:
  4776. from backend.app.services.archive import extract_printable_objects_from_3mf
  4777. client = printer_manager.get_client(printer_id)
  4778. if client:
  4779. with open(temp_path, "rb") as f:
  4780. threemf_data = f.read()
  4781. # Extract with positions for UI overlay, scoped to the
  4782. # plate that is printing — an all-plates 3MF carries
  4783. # every plate's objects (#2522).
  4784. printable_objects, bbox_all = extract_printable_objects_from_3mf(
  4785. threemf_data,
  4786. plate_number=resolve_plate_id(client.state),
  4787. include_positions=True,
  4788. )
  4789. if printable_objects:
  4790. # Store objects in printer state
  4791. client.state.printable_objects = printable_objects
  4792. client.state.printable_objects_bbox_all = bbox_all
  4793. client.state.skipped_objects = [] # Reset skipped objects for new print
  4794. logger.info(
  4795. "Loaded %s printable objects for printer %s", len(printable_objects), printer_id
  4796. )
  4797. except Exception as e:
  4798. logger.debug("Failed to extract printable objects: %s", e)
  4799. # Store Spoolman tracking data for per-filament usage reporting
  4800. try:
  4801. await _store_spoolman_print_data(
  4802. printer_id,
  4803. archive.id,
  4804. archive.file_path,
  4805. db,
  4806. printer_manager,
  4807. ams_mapping=_get_start_ams_mapping(data, archive.id),
  4808. plate_id=_get_start_plate_id(archive.id),
  4809. )
  4810. except Exception as e:
  4811. logger.warning("[SPOOLMAN] Failed to store tracking data: %s", e)
  4812. # Capture timelapse file baseline for snapshot-diff on completion
  4813. await _capture_timelapse_baseline_at_start(printer, printer_id, logger, archive_id=archive.id)
  4814. finally:
  4815. # Keep temp_path around until print completes so the cover endpoint
  4816. # can reuse it (#972). Cache eviction in on_print_complete deletes
  4817. # the file. If the cache entry was evicted early (file vanished),
  4818. # clean up any stragglers here to avoid leaking disk on retries.
  4819. cached_now = get_cached_3mf(printer_id, downloaded_filename) if downloaded_filename else None
  4820. if temp_path and temp_path.exists() and cached_now != temp_path:
  4821. temp_path.unlink()
  4822. _TIMELAPSE_VIDEO_EXTENSIONS = (".mp4", ".avi")
  4823. # Poll schedule for the post-print timelapse scan (#2704). Module-level so
  4824. # tests can shrink them without waiting out real delays.
  4825. #
  4826. # This replaced a fixed [5, 10, 20, 30] retry ladder, i.e. roughly 65 s of
  4827. # looking. Across 247 support bundles the attempt that found the video was #1
  4828. # 272 times, then 17 / 13 / 13 — a flat tail against the cutoff rather than a
  4829. # decaying one, which is the signature of a budget that expires while files are
  4830. # still arriving. 457 scans were scheduled and only 262 ever attached. Big
  4831. # prints make big videos and the printer writes them after the print ends, so
  4832. # the poll now runs for minutes and costs one FTP LIST per round.
  4833. _TIMELAPSE_SCAN_FIRST_DELAY_SECONDS: float = 5.0
  4834. _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS: float = 30.0
  4835. _TIMELAPSE_SCAN_TIMEOUT_SECONDS: float = 900.0
  4836. def _timelapse_scan_max_attempts() -> int:
  4837. """Round cap for the poll, derived from the wall-clock budget.
  4838. The deadline alone is not a sufficient bound: it assumes each round really
  4839. waits, which stops being true the moment ``asyncio.sleep`` is patched out,
  4840. and an FTP list that fails immediately would otherwise spin against the
  4841. printer at full speed for the whole window. Whichever bound is reached
  4842. first ends the poll.
  4843. """
  4844. if _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS <= 0:
  4845. # A zero interval makes the wall-clock budget meaningless; fall back to
  4846. # the round count the production interval would have given.
  4847. return 32
  4848. return max(1, int(_TIMELAPSE_SCAN_TIMEOUT_SECONDS // _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS) + 1)
  4849. async def _claimed_timelapse_names(db, printer_id: int, exclude_archive_id: int) -> set[str]:
  4850. """Video filenames already attached to some other archive of this printer.
  4851. Used to disambiguate when more than one file is new since the baseline —
  4852. which happens when a previous print's video landed after this print's
  4853. baseline was taken. Ordering the candidates would be the obvious fix and is
  4854. the wrong one: it can only be done on mtime or on the filename timestamp,
  4855. both of which come from the printer's own clock, and a LAN-only printer
  4856. can't reach Bambu's NTP server. Exclusion needs no clock at all.
  4857. ``attach_timelapse`` saves the video into the archive directory under the
  4858. printer's original filename, and the later MP4 conversion keeps the stem,
  4859. so the stem of ``timelapse_path`` recovers what was claimed.
  4860. """
  4861. from backend.app.models.archive import PrintArchive
  4862. rows = await db.execute(
  4863. select(PrintArchive.timelapse_path).where(
  4864. PrintArchive.printer_id == printer_id,
  4865. PrintArchive.id != exclude_archive_id,
  4866. PrintArchive.timelapse_path.is_not(None),
  4867. )
  4868. )
  4869. return {Path(p).stem for p in rows.scalars().all() if p}
  4870. def _timelapse_listing_is_trustworthy(printer) -> bool:
  4871. """Whether an *empty* timelapse listing for *printer* can be believed.
  4872. ``list_files_async`` answers ``[]`` when its connect fails rather than
  4873. raising, so a card behind the FTPS handshake cool-off is indistinguishable
  4874. from one holding no videos. Everywhere that only wants to know "is there a
  4875. video yet" the difference does not matter — both mean "not yet, retry".
  4876. It matters where an empty listing is recorded as a *baseline*. Recording
  4877. "the card held nothing" for a card that was never read means every video on
  4878. it counts as new once the cool-off expires, and the completion scan then
  4879. attaches a stale video to this print and deletes it from the printer
  4880. (#2957 follow-up). Those two callers ask this first.
  4881. """
  4882. from backend.app.services.bambu_ftp import ftps_handshake_blocked
  4883. ip_address = getattr(printer, "ip_address", None)
  4884. if not ip_address:
  4885. return True
  4886. return not ftps_handshake_blocked(ip_address)
  4887. async def _list_timelapse_videos(printer) -> tuple[list[dict], str | None]:
  4888. """List video files from printer's timelapse directory.
  4889. Finds MP4 (X1/A1 series) and AVI (P1 series) timelapse files.
  4890. Returns (video_files, found_path) where video_files is a list of file dicts
  4891. and found_path is the directory where they were found, or ([], None).
  4892. An empty return does not distinguish "no videos" from "could not read the
  4893. card" — see :func:`_timelapse_listing_is_trustworthy`, which the two
  4894. baseline callers consult before believing one.
  4895. """
  4896. from backend.app.services.bambu_ftp import list_files_async
  4897. logger = logging.getLogger(__name__)
  4898. # No card in the slot means no /timelapse to walk — four connections that
  4899. # can only fail, on a path whose failures are swallowed and so would go on
  4900. # costing time silently forever (#2780).
  4901. #
  4902. # ``getattr`` rather than ``printer.id``: every dereference below happens
  4903. # inside the loop's own try/except, so a caller that passed something
  4904. # unexpected used to get an empty listing rather than an exception. Keep
  4905. # that, instead of making this gate the first thing that can raise here.
  4906. printer_id = getattr(printer, "id", None)
  4907. if printer_id is not None and not external_storage_present(printer_manager.get_status(printer_id)):
  4908. logger.debug("[TIMELAPSE] Skipping the scan for printer %s: it reports no external storage", printer_id)
  4909. return [], None
  4910. for timelapse_path in ["/timelapse", "/timelapse/video", "/record", "/recording"]:
  4911. try:
  4912. found_files = await list_files_async(
  4913. printer.ip_address, printer.access_code, timelapse_path, printer_model=printer.model
  4914. )
  4915. if found_files:
  4916. video_files = [
  4917. f
  4918. for f in found_files
  4919. if not f.get("is_directory") and f.get("name", "").lower().endswith(_TIMELAPSE_VIDEO_EXTENSIONS)
  4920. ]
  4921. if video_files:
  4922. return video_files, timelapse_path
  4923. except Exception as e:
  4924. logger.debug("[TIMELAPSE] Path %s failed: %s", timelapse_path, e)
  4925. continue
  4926. return [], None
  4927. async def _capture_timelapse_baseline_at_start(
  4928. printer, printer_id: int, logger: logging.Logger, archive_id: int | None = None
  4929. ) -> None:
  4930. """Snapshot the printer's timelapse directory at print start so the
  4931. completion-time scan can pick the new file by set-difference.
  4932. Must be called from every on_print_start path that proceeds to a real
  4933. print — both the new-archive branch and the expected-archive branch (which
  4934. queue / VP-dispatched prints take). Without a baseline,
  4935. _scan_for_timelapse_with_retries falls into its "take baseline now"
  4936. fallback that runs AFTER the new MP4 has already landed on the SD card,
  4937. so the new file ends up in the "baseline" set and no diff ever matches.
  4938. Bambu printers in LAN-only mode don't sync NTP, so mtime ordering is
  4939. unreliable — the snapshot-diff approach sidesteps that entirely.
  4940. When ``archive_id`` is known the baseline is also written to the archive
  4941. row, so it survives a restart and the manual "Scan for Timelapse" button
  4942. can run the same diff instead of falling back to clock-based matching
  4943. (#2704). Only baselines taken at print start are persisted — one taken at
  4944. completion already contains the new video and would poison a later scan.
  4945. """
  4946. names: set[str] | None = None
  4947. try:
  4948. if not _timelapse_listing_is_trustworthy(printer):
  4949. # Recorded anyway, deliberately. An empty baseline taken off a card
  4950. # we could not read is not authoritative, but it is still the right
  4951. # *default*: Bambuddy deletes each video from the printer once it is
  4952. # attached, so the usual card holds exactly one video at completion
  4953. # and an empty baseline resolves it correctly. Persisting NULL
  4954. # instead would send completion to take its own snapshot, by which
  4955. # point this print's video is on the card and would be swallowed by
  4956. # it. The ambiguity is handled where it actually bites — see
  4957. # ``require_unambiguous`` in the scan (#2957 follow-up).
  4958. logger.warning(
  4959. "[TIMELAPSE] Baseline for printer %s taken while its file service is in the FTPS "
  4960. "handshake cool-off, so the card could not be read — treating it as empty",
  4961. printer_id,
  4962. )
  4963. baseline_files, _ = await _list_timelapse_videos(printer)
  4964. names = {f.get("name", "") for f in baseline_files}
  4965. _timelapse_baselines[printer_id] = names
  4966. logger.info(
  4967. "[TIMELAPSE] Baseline at print start: %s video files for printer %s",
  4968. len(names),
  4969. printer_id,
  4970. )
  4971. except Exception as e:
  4972. logger.warning("[TIMELAPSE] Failed to capture baseline at print start: %s", e)
  4973. if archive_id is None:
  4974. return
  4975. try:
  4976. async with async_session() as db:
  4977. from backend.app.models.archive import PrintArchive
  4978. archive = await db.get(PrintArchive, archive_id)
  4979. if archive is not None:
  4980. # Written even when the listing failed, and then as NULL. A
  4981. # reprint reuses the archive row, so leaving the previous run's
  4982. # baseline in place would have the scan diff this print against
  4983. # the state of the printer before the *last* one — and a stale
  4984. # baseline reads as authoritative, where NULL correctly falls
  4985. # back to a fresh snapshot.
  4986. archive.timelapse_baseline = sorted(names) if names is not None else None
  4987. await db.commit()
  4988. except Exception as e:
  4989. # In-memory baseline still covers the normal completion path.
  4990. logger.warning("[TIMELAPSE] Failed to persist baseline for archive %s: %s", archive_id, e)
  4991. async def _scan_for_timelapse_with_retries(archive_id: int, baseline_names: set[str] | None = None):
  4992. """Poll the printer for this print's timelapse and attach it.
  4993. Snapshot diff, not timestamp matching: a printer in LAN-only mode cannot
  4994. reach Bambu's NTP server, so the clock behind both the filename and the FTP
  4995. mtime is arbitrarily wrong — one reporter's P1S was six and a half days out
  4996. (#2704). Comparing the current listing against the set of filenames that
  4997. existed when the print started needs no clock at all, because the printer
  4998. writes the video only once the print has ended.
  4999. Baseline precedence: the caller's in-memory set, then the one persisted on
  5000. the archive at print start, then a snapshot taken now. The last of those is
  5001. a poor substitute — by completion the new video may already be on the card,
  5002. in which case it lands in the "baseline" and no diff can ever match — but it
  5003. is all that is available for a print that began before Bambuddy started.
  5004. On success the video is deleted from the printer, which keeps ``/timelapse``
  5005. down to the unclaimed files and makes the next diff unambiguous.
  5006. """
  5007. logger = logging.getLogger(__name__)
  5008. # Cleared when the baseline had to be taken off a card we could not read, so
  5009. # the attach step refuses to choose between several candidates (#2957).
  5010. baseline_trusted = True
  5011. # --- Phase 1: establish the baseline -------------------------------------
  5012. try:
  5013. async with async_session() as db:
  5014. from backend.app.models.printer import Printer
  5015. service = ArchiveService(db)
  5016. archive = await service.get_archive(archive_id)
  5017. if not archive:
  5018. logger.warning("[TIMELAPSE] Archive %s not found, aborting", archive_id)
  5019. return
  5020. if archive.timelapse_path:
  5021. logger.info("[TIMELAPSE] Archive %s already has timelapse attached", archive_id)
  5022. return
  5023. if not archive.printer_id:
  5024. logger.warning("[TIMELAPSE] Archive %s has no printer, aborting", archive_id)
  5025. return
  5026. if baseline_names is not None:
  5027. logger.info(
  5028. "[TIMELAPSE] Using print-start baseline: %s existing video files for archive %s",
  5029. len(baseline_names),
  5030. archive_id,
  5031. )
  5032. elif archive.timelapse_baseline is not None:
  5033. # Persisted at print start — survives a restart mid-print.
  5034. baseline_names = set(archive.timelapse_baseline)
  5035. logger.info(
  5036. "[TIMELAPSE] Using stored baseline: %s existing video files for archive %s",
  5037. len(baseline_names),
  5038. archive_id,
  5039. )
  5040. else:
  5041. result = await db.execute(select(Printer).where(Printer.id == archive.printer_id))
  5042. printer = result.scalar_one_or_none()
  5043. if not printer:
  5044. logger.warning("[TIMELAPSE] Printer not found for archive %s, aborting", archive_id)
  5045. return
  5046. if not _timelapse_listing_is_trustworthy(printer):
  5047. # The card is unreadable at the one moment a baseline has to
  5048. # be taken, so the empty listing below means "we never
  5049. # looked", not "these are all new". Carry on with it anyway
  5050. # — the usual card holds exactly one video, which resolves
  5051. # correctly — but stop the poll from *choosing* between
  5052. # several, which is how a stale video got attached to this
  5053. # print and then deleted off the printer (#2957 follow-up).
  5054. baseline_trusted = False
  5055. logger.warning(
  5056. "[TIMELAPSE] Baseline for archive %s taken while printer %s is in the FTPS "
  5057. "handshake cool-off. A single new video still resolves; several will not be "
  5058. "guessed between — use Scan for Timelapse to pick one by hand",
  5059. archive_id,
  5060. archive.printer_id,
  5061. )
  5062. baseline_files, _ = await _list_timelapse_videos(printer)
  5063. baseline_names = {f.get("name", "") for f in baseline_files}
  5064. logger.info(
  5065. "[TIMELAPSE] Baseline snapshot (fallback): %s existing video files for archive %s",
  5066. len(baseline_names),
  5067. archive_id,
  5068. )
  5069. except Exception as e:
  5070. logger.warning("[TIMELAPSE] Failed to take baseline snapshot for archive %s: %s", archive_id, e)
  5071. return
  5072. # --- Phase 2: poll for a file that was not there when the print began -----
  5073. deadline = time.monotonic() + _TIMELAPSE_SCAN_TIMEOUT_SECONDS
  5074. max_attempts = _timelapse_scan_max_attempts()
  5075. seen_names: set[str] = set()
  5076. delay = _TIMELAPSE_SCAN_FIRST_DELAY_SECONDS
  5077. attempt = 0
  5078. while True:
  5079. await asyncio.sleep(delay)
  5080. delay = _TIMELAPSE_SCAN_POLL_INTERVAL_SECONDS
  5081. attempt += 1
  5082. try:
  5083. from backend.app.models.printer import Printer
  5084. # Read phase: fetch archive + printer in a short session and release
  5085. # the pooled connection BEFORE the FTP list/download below. Holding it
  5086. # across the FTP round-trips left one connection idle-in-transaction per
  5087. # in-flight scan (issue #2572).
  5088. async with async_session() as db:
  5089. service = ArchiveService(db)
  5090. archive = await service.get_archive(archive_id)
  5091. if not archive:
  5092. logger.warning("[TIMELAPSE] Archive %s not found, stopping poll", archive_id)
  5093. return
  5094. if archive.timelapse_path:
  5095. logger.info("[TIMELAPSE] Archive %s already has timelapse attached, stopping poll", archive_id)
  5096. return
  5097. result = await db.execute(select(Printer).where(Printer.id == archive.printer_id))
  5098. printer = result.scalar_one_or_none()
  5099. if not printer:
  5100. logger.warning("[TIMELAPSE] Printer not found for archive %s, stopping poll", archive_id)
  5101. return
  5102. claimed = await _claimed_timelapse_names(db, archive.printer_id, archive_id)
  5103. # I/O phase (no DB connection held): FTP list + download.
  5104. video_files, found_path = await _list_timelapse_videos(printer)
  5105. # The poll can run for dozens of rounds, so only narrate a round
  5106. # that saw something change. Repeating the whole listing every 30 s
  5107. # would bury the one interesting line in the support bundle.
  5108. names_now = {f.get("name", "") for f in video_files}
  5109. changed = attempt == 1 or names_now != seen_names
  5110. seen_names = names_now
  5111. speak = logger.info if changed else logger.debug
  5112. if video_files:
  5113. speak("[TIMELAPSE] Attempt %s: Found %s video files in %s", attempt, len(video_files), found_path)
  5114. if changed:
  5115. for f in video_files[:5]:
  5116. logger.info("[TIMELAPSE] - %s", f.get("name"))
  5117. attached = await _attach_first_unclaimed_timelapse(
  5118. archive_id,
  5119. printer,
  5120. video_files,
  5121. baseline_names,
  5122. claimed,
  5123. attempt,
  5124. logger,
  5125. quiet=not changed,
  5126. require_unambiguous=not baseline_trusted,
  5127. )
  5128. if attached:
  5129. return
  5130. else:
  5131. speak("[TIMELAPSE] Attempt %s: No video files found, will retry", attempt)
  5132. except Exception as e:
  5133. logger.warning("[TIMELAPSE] Attempt %s failed with error: %s", attempt, e)
  5134. if attempt >= max_attempts or time.monotonic() >= deadline:
  5135. break
  5136. # No name-match fallback: it compared the print name against the filename,
  5137. # and Bambu firmware only ever writes "video_<timestamp>". Across 247 support
  5138. # bundles it fired 159 times and matched zero times, so all it added was a
  5139. # misleading log line before giving up.
  5140. logger.warning(
  5141. "[TIMELAPSE] No new video appeared for archive %s within %ss, giving up",
  5142. archive_id,
  5143. int(_TIMELAPSE_SCAN_TIMEOUT_SECONDS),
  5144. )
  5145. async def _attach_first_unclaimed_timelapse(
  5146. archive_id: int,
  5147. printer,
  5148. video_files: list[dict],
  5149. baseline_names: set[str],
  5150. claimed: set[str],
  5151. attempt: int,
  5152. logger: logging.Logger,
  5153. *,
  5154. quiet: bool = False,
  5155. require_unambiguous: bool = False,
  5156. ) -> bool:
  5157. """Download and attach the one video that belongs to this print.
  5158. A candidate is any file absent from the print-start baseline. More than one
  5159. can qualify when a previous print's video landed late, after this print's
  5160. baseline was taken — those are filtered out by name, because they are
  5161. already attached to another archive. Sorting the candidates instead would
  5162. mean sorting on mtime or on the filename timestamp, both of which come from
  5163. the printer's unsynced clock.
  5164. Returns True once a video is attached. The printer's copy is deleted only
  5165. after the attach succeeds on bytes whose length matched the listing.
  5166. ``quiet`` downgrades the "nothing yet" lines to DEBUG when the caller has
  5167. already seen this exact listing — the poll runs for many rounds and only the
  5168. rounds where something changed are worth an INFO line.
  5169. """
  5170. from backend.app.services.bambu_ftp import (
  5171. delete_archived_timelapse,
  5172. download_file_bytes_async,
  5173. remote_file_settled,
  5174. )
  5175. speak = logger.debug if quiet else logger.info
  5176. new_files = [f for f in video_files if f.get("name", "") not in baseline_names]
  5177. if not new_files:
  5178. speak("[TIMELAPSE] Attempt %s: No new files since baseline, will retry", attempt)
  5179. return False
  5180. candidates = [f for f in new_files if Path(f.get("name", "")).stem not in claimed]
  5181. if not candidates:
  5182. speak(
  5183. "[TIMELAPSE] Attempt %s: %s new file(s), all already attached to other archives, will retry",
  5184. attempt,
  5185. len(new_files),
  5186. )
  5187. return False
  5188. if len(candidates) > 1:
  5189. if require_unambiguous:
  5190. # The baseline is not evidence -- it was taken off a card that could
  5191. # not be read -- so "new since the baseline" does not narrow these
  5192. # down at all. Taking the first would attach an arbitrary video to
  5193. # this print and then delete it from the printer.
  5194. logger.warning(
  5195. "[TIMELAPSE] Attempt %s: %s unclaimed videos (%s) and no baseline to tell them apart — "
  5196. "leaving all of them on the printer for manual selection",
  5197. attempt,
  5198. len(candidates),
  5199. ", ".join(str(f.get("name")) for f in candidates),
  5200. )
  5201. return False
  5202. logger.warning(
  5203. "[TIMELAPSE] Attempt %s: %s unclaimed new files (%s) — taking the first; "
  5204. "the rest stay on the printer for manual selection",
  5205. attempt,
  5206. len(candidates),
  5207. ", ".join(str(f.get("name")) for f in candidates),
  5208. )
  5209. target = candidates[0]
  5210. file_name = target.get("name")
  5211. remote_path = target.get("path") or f"/timelapse/{file_name}"
  5212. logger.info(
  5213. "[TIMELAPSE] Attempt %s: New file detected: %s (downloading for archive %s)",
  5214. attempt,
  5215. file_name,
  5216. archive_id,
  5217. )
  5218. # The listing always carries a size (`list_files` skips entries it can't
  5219. # parse), but read it explicitly: the delete below is destructive and must
  5220. # depend on a size we actually had, not on one we hoped was there.
  5221. expected_size = target.get("size")
  5222. timelapse_data = await download_file_bytes_async(
  5223. printer.ip_address,
  5224. printer.access_code,
  5225. remote_path,
  5226. printer_model=printer.model,
  5227. expected_size=expected_size,
  5228. )
  5229. if not timelapse_data:
  5230. # Short or failed transfer. The printer keeps its copy, so the next
  5231. # round can try again — which is exactly why the delete below is
  5232. # gated on a verified download.
  5233. logger.warning("[TIMELAPSE] Attempt %s: Failed to download new file, will retry", attempt)
  5234. return False
  5235. # The length check above proves we got what the listing said, not that the
  5236. # printer had finished writing. A video still being written can be listed
  5237. # short, served short, and pass — so confirm it has stopped growing before
  5238. # committing to it and deleting the original (#2704).
  5239. if not await remote_file_settled(
  5240. printer.ip_address,
  5241. printer.access_code,
  5242. remote_path,
  5243. len(timelapse_data),
  5244. printer_model=printer.model,
  5245. ):
  5246. return False
  5247. # Write phase: attach in a fresh short-lived session.
  5248. async with async_session() as db:
  5249. success = await ArchiveService(db).attach_timelapse(archive_id, timelapse_data, file_name)
  5250. if not success:
  5251. logger.warning("[TIMELAPSE] Failed to attach timelapse to archive %s", archive_id)
  5252. return False
  5253. logger.info("[TIMELAPSE] Successfully attached timelapse to archive %s", archive_id)
  5254. await ws_manager.send_archive_updated({"id": archive_id, "timelapse_attached": True})
  5255. await delete_archived_timelapse(
  5256. printer.ip_address,
  5257. printer.access_code,
  5258. remote_path,
  5259. verified=expected_size is not None,
  5260. printer_model=printer.model,
  5261. printer_name=printer.name,
  5262. )
  5263. return True
  5264. # Defaults for the finish-photo-from-timelapse polling loop (#1397). These are
  5265. # module-level so tests can monkeypatch them down to ~0 without timing out.
  5266. _FINISH_PHOTO_TIMELAPSE_POLL_INTERVAL_SECONDS: float = 3.0
  5267. _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS: float = 60.0
  5268. # How long the *background* upgrade keeps waiting after the notification has
  5269. # already gone out (#2704 follow-up). The short bound above exists so a slow
  5270. # printer can't hold up the print-complete notification; this one exists so the
  5271. # archive still ends up with the better frame afterwards.
  5272. #
  5273. # Measured across 261 attaches in the support bundles, the video lands a median
  5274. # 13s after the print ends — but the P1 series writes MJPEG AVI rather than
  5275. # H.264 MP4 and serves it slowly, so its p90 is 167s and the worst observed case
  5276. # was 546s. Every other model was inside 26s. The long budget is therefore
  5277. # almost entirely for P1-series users; on everything else the short wait already
  5278. # wins and this task never runs.
  5279. _FINISH_PHOTO_UPGRADE_TIMEOUT_SECONDS: float = 900.0
  5280. async def _capture_finish_photo_from_timelapse(
  5281. archive_id: int,
  5282. archive_dir: Path,
  5283. timeout: float | None = None,
  5284. rotation: int = 0,
  5285. ) -> tuple[str | None, bool]:
  5286. """Wait for the per-print timelapse to land on the archive and extract its
  5287. last frame as the finish photo (#1397).
  5288. Bambu firmware stops timelapse recording after the toolhead parks but
  5289. before the bed-drop end-gcode runs, so the last frame frames the finished
  5290. print correctly. A live camera grab at gcode_state=FINISH captures the
  5291. bed already lowered.
  5292. ``_scan_for_timelapse_with_retries`` runs in parallel and writes
  5293. ``archive.timelapse_path`` when the file lands. This function polls for
  5294. that field.
  5295. Returns ``(filename, still_pending)``. ``still_pending`` is True only when
  5296. the wait ran out with no video on the archive yet — i.e. the video may
  5297. still be coming and a later attempt could succeed. It is False when the
  5298. video landed (whether or not extraction worked), because in that case
  5299. waiting longer changes nothing. The caller uses that to decide between
  5300. falling back permanently and scheduling a background upgrade.
  5301. ``rotation`` is the printer's camera_rotation, applied to the extracted
  5302. still (#2708) so this source agrees with every other finish-photo source.
  5303. The archived video itself is the printer's own file and is left alone —
  5304. rotating it would mean re-encoding it.
  5305. """
  5306. import uuid
  5307. from backend.app.models.archive import PrintArchive
  5308. from backend.app.services.camera import apply_camera_rotation_to_file, extract_video_last_frame
  5309. logger = logging.getLogger(__name__)
  5310. budget = _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS if timeout is None else timeout
  5311. deadline = asyncio.get_event_loop().time() + budget
  5312. poll_interval = _FINISH_PHOTO_TIMELAPSE_POLL_INTERVAL_SECONDS
  5313. while True:
  5314. async with async_session() as db:
  5315. result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  5316. archive = result.scalar_one_or_none()
  5317. timelapse_relpath = archive.timelapse_path if archive else None
  5318. if timelapse_relpath:
  5319. video_path = app_settings.base_dir / timelapse_relpath
  5320. if video_path.exists() and video_path.stat().st_size > 0:
  5321. photos_dir = archive_dir / "photos"
  5322. photos_dir.mkdir(parents=True, exist_ok=True)
  5323. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  5324. filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  5325. output_path = photos_dir / filename
  5326. if await extract_video_last_frame(video_path, output_path):
  5327. await apply_camera_rotation_to_file(output_path, rotation, logger)
  5328. logger.info(
  5329. "[PHOTO-BG] Extracted finish photo from timelapse %s for archive %s",
  5330. video_path.name,
  5331. archive_id,
  5332. )
  5333. return filename, False
  5334. logger.warning(
  5335. "[PHOTO-BG] Timelapse %s landed but last-frame extraction failed for archive %s; falling back",
  5336. video_path.name,
  5337. archive_id,
  5338. )
  5339. return None, False
  5340. if asyncio.get_event_loop().time() >= deadline:
  5341. logger.info(
  5342. "[PHOTO-BG] Timelapse for archive %s didn't land within %.0fs; falling back to live camera",
  5343. archive_id,
  5344. budget,
  5345. )
  5346. return None, True
  5347. await asyncio.sleep(poll_interval)
  5348. async def _upgrade_finish_photo_from_timelapse(archive_id: int, archive_dir: Path, rotation: int = 0) -> None:
  5349. """Add the timelapse's last frame to an archive after the fact (#2704).
  5350. The print-complete notification waits only ~60s for the video, because
  5351. holding a notification for minutes is worse than sending it with a live
  5352. camera grab. On a P1-series printer the video often lands well after that,
  5353. so the archive used to be stuck with the live grab — which is taken at
  5354. ``gcode_state=FINISH``, after the end G-code has dropped the bed, and is
  5355. the worse photo of the two.
  5356. This keeps waiting in the background and, when the video arrives, extracts
  5357. the frame and puts it *first* in the archive's photo list, so opening the
  5358. gallery shows it. The live grab is deliberately kept: the notification that
  5359. already went out links to that exact file, and deleting it would leave a
  5360. broken image in Discord or Telegram.
  5361. """
  5362. logger = logging.getLogger(__name__)
  5363. filename, _ = await _capture_finish_photo_from_timelapse(
  5364. archive_id, archive_dir, timeout=_FINISH_PHOTO_UPGRADE_TIMEOUT_SECONDS, rotation=rotation
  5365. )
  5366. if not filename:
  5367. logger.info("[PHOTO-UPGRADE] No timelapse frame for archive %s; keeping the live grab", archive_id)
  5368. return
  5369. try:
  5370. async with async_session() as db:
  5371. from backend.app.models.archive import PrintArchive
  5372. archive = await db.get(PrintArchive, archive_id)
  5373. if archive is None:
  5374. return
  5375. photos = list(archive.photos or [])
  5376. if filename in photos:
  5377. return
  5378. # Front of the list: PhotoGalleryModal opens at index 0.
  5379. archive.photos = [filename, *photos]
  5380. await db.commit()
  5381. except Exception as e:
  5382. logger.warning("[PHOTO-UPGRADE] Failed to attach upgraded photo to archive %s: %s", archive_id, e)
  5383. return
  5384. logger.info("[PHOTO-UPGRADE] Archive %s now leads with the timelapse frame %s", archive_id, filename)
  5385. await ws_manager.send_archive_updated({"id": archive_id, "photo_added": filename})
  5386. async def _restore_usage_tracking_session(printer_id: int, state, db, logger) -> None:
  5387. """Put the filament-attribution context back after a restart mid-print.
  5388. ``usage_tracker._active_sessions`` and ``PrinterState.tray_change_log``
  5389. both die with the process. The print keeps running, so at completion the
  5390. tracker would fall back to whatever the printer reports *now* — and AMS
  5391. filament backup makes "now" the substitute tray, charging the whole print
  5392. to the spool that only finished it.
  5393. The persisted row is only trusted when its print name still matches what
  5394. the printer says it is running: a row left behind by a completion we never
  5395. saw must not attach itself to the next print.
  5396. """
  5397. try:
  5398. from backend.app.api.routes.settings import get_setting
  5399. from backend.app.services.usage_tracker import (
  5400. clear_persisted_session,
  5401. get_persisted_print_name,
  5402. restore_session,
  5403. )
  5404. persisted_name = await get_persisted_print_name(db, printer_id)
  5405. current_name = (state.subtask_name or "").strip()
  5406. if persisted_name and current_name and persisted_name.strip() != current_name:
  5407. logger.info(
  5408. "[RESTART] Discarding stale print session for printer %s (%r != running %r)",
  5409. printer_id,
  5410. persisted_name,
  5411. current_name,
  5412. )
  5413. await clear_persisted_session(db, printer_id)
  5414. # Fall through to seeding: the print on the printer is real, it just
  5415. # isn't the one the row described.
  5416. persisted_log = None
  5417. else:
  5418. # Spoolman users get the tray-change log back but no in-memory
  5419. # session — see ``on_print_start`` on why that dict is load-bearing
  5420. # for the remain%-sync guard.
  5421. _spoolman_on = await get_setting(db, "spoolman_enabled")
  5422. persisted_log = await restore_session(
  5423. db,
  5424. printer_id,
  5425. register_active=not (bool(_spoolman_on) and _spoolman_on.lower() == "true"),
  5426. )
  5427. if persisted_log:
  5428. restored = [tuple(entry) for entry in persisted_log if isinstance(entry, (list, tuple)) and len(entry) == 2]
  5429. # Anything this process already observed goes after the persisted
  5430. # history — the log is ordered by layer, and a fresh process can
  5431. # only have seen changes from later in the print.
  5432. for entry in state.tray_change_log or []:
  5433. if tuple(entry) not in restored:
  5434. restored.append(tuple(entry))
  5435. state.tray_change_log = restored
  5436. tray_now = state.tray_now
  5437. if 0 <= tray_now <= 254:
  5438. if not state.tray_change_log:
  5439. # No persisted history — a print that started before this build,
  5440. # or before the row existed. Seed with the tray feeding right
  5441. # now so the remainder of the print is at least attributable to
  5442. # the right spool.
  5443. state.tray_change_log = [(tray_now, state.layer_num)]
  5444. logger.info(
  5445. "[RESTART] Seeded tray change log for printer %s: tray=%d at layer=%d",
  5446. printer_id,
  5447. tray_now,
  5448. state.layer_num,
  5449. )
  5450. # The tray handler updates ``last_loaded_tray`` on every push
  5451. # regardless of whether it logged a change, so re-align it to avoid
  5452. # a duplicate entry on the next push. Only ever with a real tray:
  5453. # ``last_loaded_tray`` is the "survives the end-of-print retract to
  5454. # 255" fallback, and writing 255 into it would defeat that.
  5455. state.last_loaded_tray = tray_now
  5456. except Exception:
  5457. # Never let attribution recovery cost the caller its timelapse
  5458. # baseline — that capture has to happen before the printer uploads
  5459. # the in-flight MP4 and there is no second chance at it.
  5460. logger.exception("[RESTART] Failed to restore usage-tracking session for printer %s", printer_id)
  5461. async def on_print_running_observed(printer_id: int, data: dict):
  5462. """Restart-recovery for a print that started before Bambuddy came up.
  5463. bambu_mqtt.py suppresses ``on_print_start`` on the first RUNNING push
  5464. after Bambuddy startup (#1304 guard, prevents duplicate archive
  5465. creation). This hook restores the persisted archive into ``_active_prints``
  5466. and captures the timelapse baseline that normally hangs off print start.
  5467. Fires once per session, in lieu of on_print_start when restart-recovery
  5468. kicks in. The printer doesn't upload the timelapse until after PRINT
  5469. COMPLETE, so a baseline captured any time during the print is still
  5470. pre-upload.
  5471. """
  5472. logger = logging.getLogger(__name__)
  5473. async with async_session() as db:
  5474. from backend.app.models.printer import Printer
  5475. state = printer_manager.get_status(printer_id)
  5476. if state is not None:
  5477. authorization = await _is_bambuddy_authorized_print(printer_id, state, db)
  5478. if authorization is True:
  5479. logger.info("[RESTART] Restored active Bambuddy print for printer %s", printer_id)
  5480. await _restore_usage_tracking_session(printer_id, state, db, logger)
  5481. await _restore_printable_objects(printer_id, state, db, logger)
  5482. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  5483. printer = result.scalar_one_or_none()
  5484. if not printer:
  5485. logger.warning(
  5486. "[TIMELAPSE] on_print_running_observed: printer %s not found in DB, skipping baseline",
  5487. printer_id,
  5488. )
  5489. return
  5490. # Avoid double-capture: ownership reconciliation above must still run when
  5491. # a baseline already exists, but the camera work itself is one-shot.
  5492. if printer_id in _timelapse_baselines:
  5493. logger.debug(
  5494. "[TIMELAPSE] on_print_running_observed: baseline already present for printer %s, skipping",
  5495. printer_id,
  5496. )
  5497. return
  5498. await _capture_timelapse_baseline_at_start(printer, printer_id, logger)
  5499. def _is_active_archive_stale(archive, state) -> tuple[bool, str]:
  5500. """Return ``(is_stale, reason)`` for an archive in ``status="printing"``
  5501. against the printer's current MQTT state.
  5502. Reconciliation triggers (#1542 follow-up — recovers from missed PRINT
  5503. COMPLETE events, typically a print finishing during an MQTT disconnect
  5504. window followed by a smart-plug power cycle):
  5505. 1. Printer state is terminal (IDLE / FINISH / FAILED). The print is
  5506. provably not running anymore — only branch that should fire under
  5507. normal disconnect-then-reconnect timing.
  5508. 2. Printer has a different ``subtask_id`` than the archive. Bambu
  5509. firmware mints a fresh ``subtask_id`` for each print, including the
  5510. ghost replay it runs after a power cycle from a leftover SD file —
  5511. so a mismatch unambiguously means the in-DB archive is no longer
  5512. the print on the printer.
  5513. 3. Printer is running but ``subtask_name`` is empty. The printer
  5514. doesn't know what it's running; the archive's reference to it is
  5515. already broken.
  5516. Conservative on purpose: PAUSE / PREPARE / SLICING and any RUNNING state
  5517. with matching subtask_id+subtask_name is left alone. The cost of a false
  5518. positive is a duplicate archive on the next real PRINT COMPLETE — the
  5519. reactive handler uses ``_active_prints`` for lookup, which the reconcile
  5520. clears on synthesis, so the real completion creates a fresh row instead
  5521. of overwriting the synthesised one (#1679). The cost of a false negative
  5522. is the ghost-print loop in #1542.
  5523. Pre-push guard (#1679): when ``state.state`` is empty or ``"unknown"``,
  5524. MQTT has connected but the first ``push_status`` response hasn't been
  5525. applied yet — ``PrinterState`` is sitting on its construction defaults.
  5526. The reconcile caller in ``on_printer_status_change`` is already gated
  5527. on a real ``state.state``, so in normal operation this branch is
  5528. unreachable; it's kept as belt-and-braces for future callers and for
  5529. the narrow window where a partial state update could arrive
  5530. (``state.state`` set but ``subtask_name`` not yet populated). Returning
  5531. ``not stale`` on degenerate input is strictly conservative: a real
  5532. stale archive will still be caught by the next push_status arriving
  5533. with terminal state.
  5534. """
  5535. current_state = (state.state or "").upper()
  5536. if current_state in ("", "UNKNOWN"):
  5537. # No real push_status yet — PrinterState defaults are not evidence.
  5538. return False, ""
  5539. if current_state in ("IDLE", "FINISH", "FAILED"):
  5540. return True, f"printer state {current_state}"
  5541. # Below here the printer is in a running / pre-running state (RUNNING /
  5542. # PAUSE / PREPARE / SLICING / etc.) — decide based on subtask identity.
  5543. current_subtask_id = (state.subtask_id or "").strip()
  5544. if archive.subtask_id and current_subtask_id and archive.subtask_id != current_subtask_id:
  5545. return True, f"subtask_id changed ({archive.subtask_id!r} → {current_subtask_id!r})"
  5546. current_subtask_name = (state.subtask_name or "").strip()
  5547. if not current_subtask_name:
  5548. return True, "printer subtask_name empty"
  5549. return False, ""
  5550. async def prime_kprofile_table(printer_id: int) -> int:
  5551. """Read the printer's calibration table once per connection.
  5552. The AMS slot card shows a K value per slot (#2854). On the printers whose
  5553. trays carry no ``k`` field of their own -- the whole H2 series, whose trays
  5554. report ``cali_idx`` and nothing else -- that number can only come from
  5555. ``state.kprofiles``, and nothing used to fill it on connect. It arrived by
  5556. luck: someone opening the Profiles page or Configure Slot, a nightly GitHub
  5557. backup, or the printer answering a query BambuStudio made on the report
  5558. topic we share. A Bambuddy that nobody visited showed a card with no K
  5559. values at all.
  5560. Only the diameters actually fitted are asked for, which is one request on a
  5561. single-nozzle printer and two on a dual. Probing the four sizes blind is
  5562. what the backup does, and it is both wasteful and the thing that used to
  5563. blank the table.
  5564. Returns the number of nozzles whose table was read.
  5565. """
  5566. client = printer_manager.get_client(printer_id)
  5567. state = printer_manager.get_status(printer_id)
  5568. if client is None or state is None or not state.connected:
  5569. return 0
  5570. # Deduplicated, order preserved: a dual-nozzle printer with two 0.4s should
  5571. # ask once, and both entries are empty until the first push_status lands.
  5572. diameters = list(dict.fromkeys(n.nozzle_diameter for n in (state.nozzles or []) if n.nozzle_diameter))
  5573. if not diameters:
  5574. logging.getLogger(__name__).debug(
  5575. "[Printer %s] No nozzle diameter reported yet; leaving the K-profile table to the next reader",
  5576. printer_id,
  5577. )
  5578. return 0
  5579. primed = 0
  5580. for diameter in diameters:
  5581. try:
  5582. profiles = await client.get_kprofiles(nozzle_diameter=diameter, max_retries=2)
  5583. except Exception as exc: # noqa: BLE001
  5584. # A printer that won't answer costs the card its K values, nothing
  5585. # more — never the connection this runs on the back of.
  5586. logging.getLogger(__name__).warning(
  5587. "[Printer %s] Could not read the K-profile table for nozzle %s: %s", printer_id, diameter, exc
  5588. )
  5589. continue
  5590. primed += 1
  5591. logging.getLogger(__name__).info(
  5592. "[Printer %s] Primed K-profile table for nozzle %s: %d profiles", printer_id, diameter, len(profiles)
  5593. )
  5594. return primed
  5595. async def reconcile_stale_active_prints(printer_id: int) -> int:
  5596. """Synthesise ``on_print_complete`` for archives whose print can't be
  5597. running on the printer anymore.
  5598. Called once per MQTT (re)connection (from on_printer_status_change when
  5599. the connected edge flips False → True) and at Bambuddy startup (from
  5600. the FastAPI lifespan). Without this, a print that completes during a
  5601. disconnect window — followed by a smart-plug-driven power cycle — leaves
  5602. the ``.3mf`` on the SD card, the firmware auto-replays it on next boot,
  5603. and Bambuddy fires a fresh PRINT START for the ghost rather than the
  5604. SD cleanup that PRINT COMPLETE was supposed to run. Repeats every
  5605. power cycle until the operator notices (#1542 follow-up). Reconciliation
  5606. closes the loop by faking the missed PRINT COMPLETE — the existing
  5607. cleanup chain handles SD-file deletion, status updates, usage tracking,
  5608. and notifications.
  5609. Synthesised ``status="aborted"`` is the conservative label: we have no
  5610. proof the print finished successfully (and no progress evidence to
  5611. promote to ``"completed"``). The real PRINT COMPLETE callback, if it
  5612. fires later, overwrites the status with the correct value.
  5613. Returns the number of archives reconciled.
  5614. """
  5615. state = printer_manager.get_status(printer_id)
  5616. if not state:
  5617. return 0
  5618. # Don't reconcile while disconnected — we'd be making a decision against
  5619. # stale cached state. The connected → reconcile edge handles this.
  5620. if not state.connected:
  5621. return 0
  5622. from backend.app.models.archive import PrintArchive
  5623. reconciled = 0
  5624. async with async_session() as db:
  5625. result = await db.execute(
  5626. select(PrintArchive).where(
  5627. PrintArchive.printer_id == printer_id,
  5628. PrintArchive.status == "printing",
  5629. )
  5630. )
  5631. active = list(result.scalars().all())
  5632. if not active:
  5633. return 0
  5634. logger = logging.getLogger(__name__)
  5635. for archive in active:
  5636. is_stale, reason = _is_active_archive_stale(archive, state)
  5637. if not is_stale:
  5638. continue
  5639. logger.info(
  5640. "[RECONCILE] Printer %s: synthesising missed PRINT COMPLETE for archive %s (%s) — %s",
  5641. printer_id,
  5642. archive.id,
  5643. archive.filename,
  5644. reason,
  5645. )
  5646. # Synthesised payload: minimal fields the on_print_complete chain
  5647. # needs. `_reconciled` marker lets downstream code distinguish this
  5648. # from a real MQTT-driven completion if it ever needs to (e.g. for
  5649. # metrics / debug logging). raw_data is the live printer state so
  5650. # the usage tracker can compare end-of-print remain% against the
  5651. # captured start values.
  5652. try:
  5653. await on_print_complete(
  5654. printer_id,
  5655. {
  5656. "status": "aborted",
  5657. "filename": archive.filename,
  5658. "subtask_name": archive.print_name or "",
  5659. "subtask_id": archive.subtask_id or "",
  5660. "raw_data": state.raw_data or {},
  5661. "_reconciled": True,
  5662. },
  5663. )
  5664. reconciled += 1
  5665. except Exception as e:
  5666. # Catch-all: a reconciliation failure must not block the
  5667. # printer's normal status flow. The archive stays in
  5668. # ``status="printing"`` and the next reconnect retries.
  5669. logger.warning(
  5670. "[RECONCILE] on_print_complete synthesis failed for archive %s: %s",
  5671. archive.id,
  5672. e,
  5673. )
  5674. return reconciled
  5675. # #2547: clearance left between the nozzle and the top of the print when the
  5676. # plate is commanded back into camera framing. The nozzle is parked away from
  5677. # the part by then, so this is belt-and-braces against a max_z_height that
  5678. # under-reports (e.g. a slicer that excludes a final Z hop).
  5679. _PLATE_RESTORE_CLEARANCE_MM = 10.0
  5680. # How far below the restored position to drop the plate again afterwards, so
  5681. # the print is as reachable as Bambu's own end G-code leaves it. Matches the
  5682. # stock `G1 Z{max_layer_z + 100}`; the firmware clamps it to the travel limit
  5683. # on machines with less headroom.
  5684. _PLATE_PARK_DROP_MM = 100.0
  5685. # Feedrate for both moves. F600 is exactly what Bambu's own end G-code uses on
  5686. # this axis, so it is a proven-safe speed for the full travel.
  5687. _PLATE_RESTORE_FEEDRATE = 600
  5688. # Time allowed for the plate to reach the restored position before the camera
  5689. # grab. Sized for the ~100 mm the stock end G-code drops at F600 (10 mm/s).
  5690. _PLATE_RESTORE_SETTLE_SECONDS = 12.0
  5691. # How long `_background_finish_photo` waits for this producer. Must cover the
  5692. # settle window plus a worst-case RTSP grab (15s), and stay below the
  5693. # notification path's own photo wait so a slow producer degrades to a
  5694. # photo-less notification rather than a missed one.
  5695. _FINISH_PHOTO_PRODUCER_WAIT_SECONDS = _PLATE_RESTORE_SETTLE_SECONDS + 23.0
  5696. async def _max_z_for_current_print(printer_id: int, data: dict, logger) -> float | None:
  5697. """Height of the print that just finished on ``printer_id``, or None (#2547).
  5698. This number becomes the target of a real Z move, so every step here refuses
  5699. rather than guesses. A height belonging to some *other* print is the one
  5700. failure that could drive the nozzle into the model: 20 mm carried onto a
  5701. 200 mm print would command the plate up through the part.
  5702. Two independent things therefore have to agree before a height is returned:
  5703. 1. **Identity.** The archive is matched by the finished print's own
  5704. ``subtask_name``, by equality rather than a ``LIKE``, so "Cube" can never
  5705. resolve to "Cube v2". Matching on "most recent archive for this printer"
  5706. is not good enough — ``on_print_complete`` pops the ``_active_prints``
  5707. binding concurrently with us, and a print Bambuddy failed to archive
  5708. would silently resolve to its predecessor.
  5709. 2. **Corroboration.** The archive's layer count (parsed from the 3MF) has to
  5710. match the layer count the printer itself reported over MQTT for the print
  5711. that just ended. These come from genuinely different sources, so a
  5712. mismatch means the row is not this print, whatever its name says.
  5713. ``completed`` is accepted alongside ``printing`` only because
  5714. ``on_print_complete`` may already have flipped the status by the time we
  5715. run; the identity check above is what actually selects the row.
  5716. """
  5717. subtask_name = (data.get("subtask_name") or "").strip()
  5718. if not subtask_name:
  5719. # Nothing to identify the print by — refuse rather than fall back to
  5720. # "whatever ran last on this printer".
  5721. logger.info("[PLATE-RESTORE] printer %s: print has no name to match on — skipping", printer_id)
  5722. return None
  5723. try:
  5724. from backend.app.models.archive import PrintArchive
  5725. from backend.app.utils.threemf_tools import extract_max_z_height_from_3mf
  5726. async with async_session() as db:
  5727. result = await db.execute(
  5728. select(PrintArchive)
  5729. .where(
  5730. PrintArchive.printer_id == printer_id,
  5731. PrintArchive.status.in_(("printing", "completed")),
  5732. PrintArchive.deleted_at.is_(None),
  5733. or_(
  5734. PrintArchive.print_name == subtask_name,
  5735. PrintArchive.filename == subtask_name,
  5736. PrintArchive.filename == f"{subtask_name}.3mf",
  5737. PrintArchive.filename == f"{subtask_name}.gcode.3mf",
  5738. ),
  5739. )
  5740. .order_by(PrintArchive.id.desc())
  5741. .limit(1)
  5742. )
  5743. archive = result.scalar_one_or_none()
  5744. if archive is None or not archive.file_path:
  5745. logger.info("[PLATE-RESTORE] printer %s: no archive matches %r — skipping", printer_id, subtask_name)
  5746. return None
  5747. client = printer_manager.get_client(printer_id)
  5748. reported_layers = getattr(getattr(client, "state", None), "total_layers", None)
  5749. if reported_layers and archive.total_layers and reported_layers != archive.total_layers:
  5750. logger.warning(
  5751. "[PLATE-RESTORE] printer %s: archive %s says %s layers but the printer reported %s "
  5752. "— refusing to move the plate on a height that may not be this print's",
  5753. printer_id,
  5754. archive.id,
  5755. archive.total_layers,
  5756. reported_layers,
  5757. )
  5758. return None
  5759. path = Path(archive.file_path)
  5760. if not path.is_absolute():
  5761. path = Path(app_settings.data_dir) / path
  5762. return await asyncio.to_thread(extract_max_z_height_from_3mf, path, archive.plate_id or 1)
  5763. except Exception as e:
  5764. logger.debug("[PLATE-RESTORE] printer %s: no usable print height: %s", printer_id, e)
  5765. return None
  5766. async def _restore_plate_for_finish_photo(printer_id: int, max_z_height: float, logger) -> bool:
  5767. """Raise the plate back into camera framing before the finish photo (#2547).
  5768. Bambu's end G-code drops the plate ~100 mm as the last thing it does, so by
  5769. the time ``gcode_state`` reaches FINISH the finished print sits far below
  5770. the camera's natural framing — the complaint behind #1145, #1397 and #1565.
  5771. This commands an absolute ``G1 Z`` back to just above the last printed
  5772. layer.
  5773. Absolute, not relative, is the whole safety argument. ``max_z_height +
  5774. clearance`` is a height the toolhead was physically at seconds earlier, so
  5775. it is inside the travel limits by construction and leaves the nozzle above
  5776. the part. It is also unambiguous across model families: Z is the
  5777. nozzle-to-bed gap whether the bed moves (X1/P1/H2) or the toolhead does
  5778. (A1), so unlike the relative bed-jog path (#1334) there is no sign to get
  5779. wrong. ``M211`` is never touched — see the bed-jog docstring for why
  5780. (#2579).
  5781. Returns True if the move was sent and waited out, False if it was skipped.
  5782. """
  5783. client = printer_manager.get_client(printer_id)
  5784. if client is None:
  5785. return False
  5786. # Re-read state immediately before commanding motion. If the queue has
  5787. # already started the next print, the printer is no longer ours to move.
  5788. state = getattr(client, "state", None)
  5789. if state is None or state.state != "FINISH":
  5790. logger.info(
  5791. "[PLATE-RESTORE] printer %s is in state %s, not FINISH — skipping",
  5792. printer_id,
  5793. getattr(state, "state", "unknown"),
  5794. )
  5795. return False
  5796. target_z = max_z_height + _PLATE_RESTORE_CLEARANCE_MM
  5797. if not client.send_gcode(f"G90\nG1 Z{target_z:.2f} F{_PLATE_RESTORE_FEEDRATE}"):
  5798. logger.warning("[PLATE-RESTORE] printer %s: send failed — capturing where it is", printer_id)
  5799. return False
  5800. logger.info(
  5801. "[PLATE-RESTORE] printer %s: plate to Z%.2f (print top %.2f + %.1f clearance), settling %.0fs",
  5802. printer_id,
  5803. target_z,
  5804. max_z_height,
  5805. _PLATE_RESTORE_CLEARANCE_MM,
  5806. _PLATE_RESTORE_SETTLE_SECONDS,
  5807. )
  5808. await asyncio.sleep(_PLATE_RESTORE_SETTLE_SECONDS)
  5809. return True
  5810. def _park_plate_after_finish_photo(printer_id: int, max_z_height: float, logger) -> None:
  5811. """Drop the plate again after the finish photo (#2547).
  5812. Without this the user walks up to a finished print sitting just under the
  5813. nozzle, which is exactly the position Bambu's end G-code goes out of its way
  5814. to avoid — awkward to lift the plate out, and easy to knock the toolhead.
  5815. Fire-and-forget: if it doesn't land, the plate is merely high, and the next
  5816. print homes anyway.
  5817. """
  5818. client = printer_manager.get_client(printer_id)
  5819. state = getattr(client, "state", None) if client else None
  5820. if client is None or state is None or state.state != "FINISH":
  5821. return
  5822. client.send_gcode(f"G90\nG1 Z{max_z_height + _PLATE_PARK_DROP_MM:.2f} F{_PLATE_RESTORE_FEEDRATE}")
  5823. logger.debug("[PLATE-RESTORE] printer %s: plate returned to unload height", printer_id)
  5824. async def _plate_restore_is_blocked_by_queue(printer_id: int) -> bool:
  5825. """True if a queue item is about to take this printer (#2547).
  5826. The scheduler dispatches the next job the moment a print completes, and a
  5827. plate move interleaved with a print start is not a race worth having. The
  5828. state re-check in ``_restore_plate_for_finish_photo`` closes the tail of
  5829. this window; this closes the head of it.
  5830. """
  5831. try:
  5832. from backend.app.models.print_queue import PrintQueueItem
  5833. async with async_session() as db:
  5834. result = await db.execute(
  5835. select(PrintQueueItem.id)
  5836. .where(
  5837. PrintQueueItem.printer_id == printer_id,
  5838. PrintQueueItem.status.in_(("pending", "printing")),
  5839. )
  5840. .limit(1)
  5841. )
  5842. return result.scalar_one_or_none() is not None
  5843. except Exception as e:
  5844. # Fail closed: if we can't tell, don't move the plate.
  5845. logging.getLogger(__name__).debug(
  5846. "[PLATE-RESTORE] queue check failed for printer %s: %s — skipping restore", printer_id, e
  5847. )
  5848. return True
  5849. async def on_finish_photo_moment(printer_id: int, data: dict):
  5850. """Pre-capture a finish photo when the printer enters stage 22 / FINISH (#1721).
  5851. Fires either at the stage-22 ("Filament unloading") edge — toolhead
  5852. parked, bed not yet dropped, optimal framing — or as a FINISH-state
  5853. fallback for prints that skip stage 22 (cancel, external-spool-only,
  5854. HMS halt, firmware variants). Grabs one frame via the same
  5855. external-camera / RTSP path the post-completion fallback uses, stores
  5856. the JPEG bytes in ``_stage22_finish_frames[printer_id]``, and lets
  5857. ``_background_finish_photo`` consume the cached bytes when it runs.
  5858. Replaces the #1397 "force timelapse on at dispatch" mechanism, which
  5859. caused per-layer nozzle parking on slicer profiles with Timelapse Type
  5860. set to Smooth (#1721). No force-on now means the user's explicit
  5861. timelapse=off in the slicer send dialog is respected.
  5862. """
  5863. logger = logging.getLogger(__name__)
  5864. trigger = data.get("trigger", "unknown")
  5865. timelapse_was_active = bool(data.get("timelapse_was_active"))
  5866. logger.info(
  5867. "[FINISH-PHOTO-MOMENT] printer=%s trigger=%s timelapse_active=%s",
  5868. printer_id,
  5869. trigger,
  5870. timelapse_was_active,
  5871. )
  5872. # If a timelapse is actively recording, skip the pre-capture — the
  5873. # post-completion path will extract the last frame from the recorded
  5874. # video, which still provides the best framing (toolhead parked,
  5875. # before bed drop) without the per-layer parking side effects.
  5876. if timelapse_was_active:
  5877. logger.info(
  5878. "[FINISH-PHOTO-MOMENT] timelapse active for printer %s — skipping pre-capture (last-frame extraction will run post-completion)",
  5879. printer_id,
  5880. )
  5881. return
  5882. # #1790: register the producer-done event BEFORE the first await so the
  5883. # consumer in `_background_finish_photo` — which is dispatched back-to-back
  5884. # with us on the FINISH-state fallback path — sees it as soon as it polls.
  5885. # The `finally` below guarantees `set()` runs on every exit, including
  5886. # early returns and exceptions, so the consumer's bounded wait can't hang.
  5887. producer_done = asyncio.Event()
  5888. _stage22_finish_in_flight[printer_id] = producer_done
  5889. # #2547: set once the plate has actually been raised, and read by the
  5890. # `finally` below. Declared out here so a failure anywhere after the move —
  5891. # a camera timeout, a DB error — still lowers the plate again.
  5892. restore_max_z: float | None = None
  5893. try:
  5894. async with async_session() as db:
  5895. from backend.app.api.routes.settings import get_setting
  5896. from backend.app.models.printer import Printer
  5897. capture_setting = await get_setting(db, "capture_finish_photo")
  5898. if capture_setting is not None and capture_setting.lower() != "true":
  5899. logger.info("[FINISH-PHOTO-MOMENT] capture_finish_photo disabled — skipping pre-capture")
  5900. return
  5901. restore_setting = await get_setting(db, "finish_photo_restore_plate")
  5902. restore_plate_enabled = restore_setting is None or restore_setting.lower() == "true"
  5903. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  5904. printer = result.scalar_one_or_none()
  5905. if printer is None:
  5906. logger.warning(
  5907. "[FINISH-PHOTO-MOMENT] printer %s not found in DB",
  5908. printer_id,
  5909. )
  5910. return
  5911. frame_bytes: bytes | None = None
  5912. # #2708: the banked frame arrives already rotated — it comes from
  5913. # `_capture_snapshot_for_notification`, which rotates before returning.
  5914. # Every other source below is a raw grab. Tracking which lets us store
  5915. # exactly one rotation in `_stage22_finish_frames` either way.
  5916. frame_already_rotated = False
  5917. # On the FINISH-state path the End G-code has already run, and two very
  5918. # different situations arrive here needing opposite answers.
  5919. #
  5920. # #1867: if Bambuddy injected End G-code into this print, a SwapMod
  5921. # snippet may have ejected the plate — the scene in front of the camera
  5922. # is no longer the finished print, and no amount of moving the plate
  5923. # brings it back. Use the banked in-print frame instead.
  5924. #
  5925. # #2547: otherwise the print is still sitting there, just ~100 mm lower
  5926. # than the camera frames well, and the toolhead is parked out of the
  5927. # way. That is the *best* moment available on firmware that never emits
  5928. # stage 22 (H2C, A1 Mini) — so capture live, after putting the plate
  5929. # back. Preferring the bank here unconditionally, as this code used to,
  5930. # is what shipped a mid-print photo with the toolhead over the part.
  5931. if trigger == "finish_state" and print_dispatch_context.end_gcode_injected(printer_id):
  5932. banked = _inprint_frame_bank.get(printer_id)
  5933. if banked:
  5934. frame_bytes = banked
  5935. frame_already_rotated = True
  5936. logger.info(
  5937. "[FINISH-PHOTO-MOMENT] End G-code was injected — using banked in-print "
  5938. "frame (%d bytes) instead of a post-swap live grab",
  5939. len(banked),
  5940. )
  5941. else:
  5942. logger.warning(
  5943. "[FINISH-PHOTO-MOMENT] End G-code was injected for printer %s but the "
  5944. "in-print bank is empty — falling back to a live grab, which may show a "
  5945. "swapped or empty plate",
  5946. printer_id,
  5947. )
  5948. # `restore_max_z` is set only once the plate is actually up, because the
  5949. # `finally` reads it to decide whether it owes a move back down.
  5950. #
  5951. # Never on a print whose End G-code Bambuddy injected, even when the bank
  5952. # came up empty above: that machine may have just ejected its plate, and
  5953. # driving Z into whatever a swap mechanism is doing is not a risk worth
  5954. # taking for a photo of a bed we already know may be bare.
  5955. if (
  5956. frame_bytes is None
  5957. and trigger == "finish_state"
  5958. and restore_plate_enabled
  5959. and not print_dispatch_context.end_gcode_injected(printer_id)
  5960. ):
  5961. wants_restore = await _max_z_for_current_print(printer_id, data, logger)
  5962. if wants_restore is None:
  5963. logger.info(
  5964. "[PLATE-RESTORE] printer %s: print height unknown — capturing without restore",
  5965. printer_id,
  5966. )
  5967. elif await _plate_restore_is_blocked_by_queue(printer_id):
  5968. logger.info(
  5969. "[PLATE-RESTORE] printer %s has queued work — skipping plate restore",
  5970. printer_id,
  5971. )
  5972. elif await _restore_plate_for_finish_photo(printer_id, wants_restore, logger):
  5973. restore_max_z = wants_restore
  5974. if frame_bytes is None and printer.external_camera_enabled and printer.external_camera_url:
  5975. from backend.app.api.routes.camera import live_frame_for_capture
  5976. from backend.app.services.external_camera import capture_frame
  5977. # #2707: this used to collide with the live view and fail, which is
  5978. # how finish-photo notifications went out with no image attached.
  5979. # Leaving frame_bytes None keeps the rest of the fallback chain.
  5980. defer, buffered = live_frame_for_capture(printer_id)
  5981. if defer:
  5982. frame_bytes = buffered
  5983. else:
  5984. frame_bytes = await capture_frame(
  5985. printer.external_camera_url,
  5986. printer.external_camera_type or "mjpeg",
  5987. snapshot_url=printer.external_camera_snapshot_url,
  5988. )
  5989. if frame_bytes:
  5990. logger.info(
  5991. "[FINISH-PHOTO-MOMENT] captured external-camera frame (%d bytes)",
  5992. len(frame_bytes),
  5993. )
  5994. elif frame_bytes is None:
  5995. from backend.app.api.routes.camera import get_buffered_frame
  5996. buffered = get_buffered_frame(printer_id)
  5997. if buffered:
  5998. frame_bytes = buffered
  5999. logger.info(
  6000. "[FINISH-PHOTO-MOMENT] used buffered RTSP frame (%d bytes)",
  6001. len(frame_bytes),
  6002. )
  6003. else:
  6004. from backend.app.services.camera import capture_camera_frame_bytes
  6005. frame_bytes = await capture_camera_frame_bytes(
  6006. ip_address=printer.ip_address,
  6007. access_code=printer.access_code,
  6008. model=printer.model,
  6009. timeout=15,
  6010. )
  6011. if frame_bytes:
  6012. logger.info(
  6013. "[FINISH-PHOTO-MOMENT] captured RTSP frame (%d bytes)",
  6014. len(frame_bytes),
  6015. )
  6016. if frame_bytes:
  6017. if not frame_already_rotated:
  6018. frame_bytes = _apply_camera_rotation(frame_bytes, printer, logger)
  6019. _stage22_finish_frames[printer_id] = frame_bytes
  6020. else:
  6021. logger.warning(
  6022. "[FINISH-PHOTO-MOMENT] no frame captured for printer %s — post-completion fallback will retry",
  6023. printer_id,
  6024. )
  6025. except Exception as e:
  6026. logger.warning(
  6027. "[FINISH-PHOTO-MOMENT] pre-capture failed for printer %s: %s",
  6028. printer_id,
  6029. e,
  6030. )
  6031. finally:
  6032. # #2547: we raised the plate, so we own lowering it — including when the
  6033. # capture above failed or threw partway through.
  6034. if restore_max_z is not None:
  6035. try:
  6036. _park_plate_after_finish_photo(printer_id, restore_max_z, logger)
  6037. except Exception as e:
  6038. logger.warning("[PLATE-RESTORE] printer %s: could not lower plate: %s", printer_id, e)
  6039. # #1790: always unblock the consumer's bounded wait — whether we stored
  6040. # a frame, gave up, or hit an exception. Local ref means cleanup of the
  6041. # dict entry by the consumer doesn't affect signalling.
  6042. producer_done.set()
  6043. def _subtask_name_from_filename(filename: str) -> str:
  6044. """Recover the subtask name a print command would have carried for *filename*.
  6045. The dispatcher derives the printer-facing subtask name from the archive's
  6046. file name, so stripping the extensions back off gives the value MQTT echoes
  6047. on completion. Only the two extensions Bambuddy actually stores are removed,
  6048. and in the order they nest (``.gcode.3mf``), so a model whose own name
  6049. contains a dot -- ``My.Model.3mf`` -- keeps it.
  6050. """
  6051. name = PurePosixPath(filename).name
  6052. for suffix in (".3mf", ".gcode"):
  6053. if name.lower().endswith(suffix):
  6054. name = name[: -len(suffix)]
  6055. return name
  6056. # How the printer marks a subtask name it had to cut short. Observed on real
  6057. # hardware at ~100 characters, but the cut-off is not a fixed character count
  6058. # (a name with multibyte characters came back at 98), so match the marker
  6059. # rather than a length.
  6060. _SUBTASK_TRUNCATION_MARKER = "..."
  6061. def _normalise_subtask_name(name: str) -> str:
  6062. """Canonical form for comparing a dispatched name against MQTT's echo.
  6063. The printer does not echo the name back verbatim: it substitutes
  6064. underscores for spaces. ``H2D_Carbon_Filter_(V2)_Body & Solid Lid`` is
  6065. dispatched and ``H2D_Carbon_Filter_(V2)_Body_&_Solid_Lid`` comes back.
  6066. The 3MF lookup in this module has always known that -- it builds
  6067. space-to-underscore variants of every candidate filename, and its
  6068. directory search normalises both sides before comparing. This exists so
  6069. the completion check reads the same rule from the same place instead of
  6070. growing its own, which is exactly how it came to disagree (#2829).
  6071. """
  6072. return name.strip().replace(" ", "_").casefold()
  6073. def _subtask_names_match(expected: str, observed: str) -> bool:
  6074. """Whether two subtask names describe the same print.
  6075. Beyond the space/underscore substitution, the printer truncates long names
  6076. and marks the cut with ``...``. A truncated echo has to count as a match or
  6077. every print with a long name strands its queue item the same way.
  6078. """
  6079. expected_n = _normalise_subtask_name(expected)
  6080. observed_n = _normalise_subtask_name(observed)
  6081. if expected_n == observed_n:
  6082. return True
  6083. # Either side can be the truncated one: the printer truncates what it
  6084. # echoes, and an archive whose own filename was recorded from a previous
  6085. # truncated echo carries the marker too.
  6086. for full, cut in ((expected_n, observed_n), (observed_n, expected_n)):
  6087. if cut.endswith(_SUBTASK_TRUNCATION_MARKER) and full.startswith(cut[: -len(_SUBTASK_TRUNCATION_MARKER)]):
  6088. return True
  6089. return False
  6090. async def _queue_item_dispatched_name(db, item) -> str:
  6091. """The subtask name *item* was dispatched under, or "" when unknowable.
  6092. A row with no archive, or an archive with no file name, is unverifiable
  6093. rather than wrong; every caller answers that with its permissive branch.
  6094. """
  6095. if item.archive_id is None:
  6096. return ""
  6097. from backend.app.models.archive import PrintArchive
  6098. archive = await db.get(PrintArchive, item.archive_id)
  6099. if archive is None or not archive.filename:
  6100. return ""
  6101. return _subtask_name_from_filename(archive.filename)
  6102. async def _completion_belongs_to_queue_item(db, item, data: dict) -> bool:
  6103. """Whether this completion event is plausibly about *item*'s print.
  6104. The caller finds its queue row by printer and ``status='printing'`` alone,
  6105. which is all a completion event gives it -- there is no run identifier in
  6106. the MQTT payload to match on. That makes the lookup indiscriminate: any
  6107. completion delivered for this printer closes whichever row happens to be
  6108. printing, however unrelated. Comparing the subtask name against the archive
  6109. the row was dispatched with costs one primary-key load and rules that out.
  6110. Deliberately permissive: it answers False only on a positive disagreement
  6111. between two names we actually have. A row with no archive, an archive with
  6112. no file name, or an event with no subtask name is unverifiable rather than
  6113. wrong, and refusing those would strand the item in ``printing`` and wedge
  6114. the printer's queue -- a worse failure than the one being prevented.
  6115. """
  6116. observed = (data.get("subtask_name") or "").strip()
  6117. if not observed or item.archive_id is None:
  6118. return True
  6119. from backend.app.models.archive import PrintArchive
  6120. archive = await db.get(PrintArchive, item.archive_id)
  6121. if archive is None or not archive.filename:
  6122. return True
  6123. expected = _subtask_name_from_filename(archive.filename)
  6124. if not expected or _subtask_names_match(expected, observed):
  6125. return True
  6126. logging.getLogger(__name__).warning(
  6127. "Ignoring print completion for queue item %s: it was dispatched as %r "
  6128. "(archive %s, %s) but the completion reports subtask %r. Leaving the item "
  6129. "printing rather than closing a run this event is not about.",
  6130. item.id,
  6131. expected,
  6132. archive.id,
  6133. archive.filename,
  6134. observed,
  6135. )
  6136. return False
  6137. async def _recover_fallback_from_cache_before_eviction(printer_id: int, data: dict) -> None:
  6138. """Spend the 3MF download cache on a still-empty fallback archive.
  6139. ``on_print_complete`` drops the cache as its first act, which deletes the
  6140. file. If the cover endpoint (or anything else) pulled the 3MF while the
  6141. print ran and the archive never got one, this is the last moment those bytes
  6142. exist (#2957).
  6143. """
  6144. logger = logging.getLogger(__name__)
  6145. names = [
  6146. n
  6147. for n in (data.get("filename"), data.get("subtask_name"), (data.get("raw_data") or {}).get("subtask_name"))
  6148. if n
  6149. ]
  6150. for name in names:
  6151. try:
  6152. cached = get_cached_3mf(printer_id, name)
  6153. if cached and await try_recover_fallback_archive(printer_id, name, cached):
  6154. return
  6155. except Exception as e:
  6156. logger.debug("[RECOVER] Pre-eviction recovery for %s failed: %s", name, e)
  6157. async def on_print_complete(printer_id: int, data: dict):
  6158. """Handle print completion - update the archive status."""
  6159. import time
  6160. logger = logging.getLogger(__name__)
  6161. start_time = time.time()
  6162. def log_timing(section: str):
  6163. elapsed = time.time() - start_time
  6164. logger.info("[TIMING] %s: %.3fs elapsed", section, elapsed)
  6165. logger.info("[CALLBACK] on_print_complete started for printer %s", printer_id)
  6166. # A kill-switch stop sends its provider notification immediately. Keep the
  6167. # task so the later notification path can await it and avoid a duplicate;
  6168. # if that immediate attempt failed, the regular completion path retries.
  6169. kill_switch_notification_task = _kill_switch_notification_tasks.pop(printer_id, None)
  6170. # Last chance before the bytes go: if this print's archive is still an empty
  6171. # fallback and something downloaded the 3MF while it ran, fill the archive in
  6172. # now. The cover endpoint's copy lives in exactly this cache, and clearing it
  6173. # below deletes the file (#2957).
  6174. await _recover_fallback_from_cache_before_eviction(printer_id, data)
  6175. # A pending cool-off retry has nothing left to recover for — the cache is
  6176. # about to be dropped and the print is over.
  6177. retry_task = _fallback_3mf_retry_tasks.pop(printer_id, None)
  6178. if retry_task and not retry_task.done():
  6179. retry_task.cancel()
  6180. # Drop the 3MF download cache for this printer (#972). The print is over,
  6181. # nothing else legitimately needs the bytes; keeping them would only risk
  6182. # handing a stale file to the next print if it reuses the same name.
  6183. clear_3mf_cache(printer_id)
  6184. try:
  6185. ws_data = {
  6186. "status": data.get("status"),
  6187. "filename": data.get("filename"),
  6188. "subtask_name": data.get("subtask_name"),
  6189. "timelapse_was_active": data.get("timelapse_was_active"),
  6190. }
  6191. await ws_manager.send_print_complete(printer_id, ws_data)
  6192. log_timing("WebSocket send_print_complete")
  6193. except Exception as e:
  6194. logger.warning("[CALLBACK] WebSocket send_print_complete failed: %s", e)
  6195. # Capture user info before clearing (needed for print log entry)
  6196. _print_user_info = printer_manager.get_current_print_user(printer_id)
  6197. # Clear current print user tracking (Issue #206)
  6198. printer_manager.clear_current_print_user(printer_id)
  6199. # If the user explicitly stopped this print from the queue UI the printer will
  6200. # report "failed" or "aborted" via MQTT. Override that to "cancelled" so the
  6201. # correct "print stopped" notification/email is sent instead of a failure alert.
  6202. _raw_status = data.get("status", "completed")
  6203. if printer_id in _user_stopped_printers and _raw_status in ("failed", "aborted"):
  6204. logger.info(
  6205. "[CALLBACK] Overriding status '%s' -> 'cancelled' for printer %s (print was stopped from queue by user)",
  6206. _raw_status,
  6207. printer_id,
  6208. )
  6209. data = {**data, "status": "cancelled"}
  6210. _user_stopped_printers.discard(printer_id)
  6211. # Raise the plate-clear gate for queued dispatch (#961). Any terminal status
  6212. # may have left material on the bed: a user can cancel ten hours into a
  6213. # twelve-hour print, a printer can self-abort mid-job after a clog, and a
  6214. # touchscreen-stop reports `aborted` rather than `cancelled` because
  6215. # `_user_stopped_printers` is only populated when the user stops via the
  6216. # Bambuddy queue UI. Earlier code raised the flag only for completed/failed,
  6217. # which auto-dispatched the next queued print onto a fouled bed two seconds
  6218. # after a touchscreen-abort (#1171). Persisted to DB so the gate survives
  6219. # Auto Off power cycles and Bambuddy restarts.
  6220. _final_status = data.get("status", "completed")
  6221. if _final_status in ("completed", "failed", "aborted", "cancelled"):
  6222. printer_manager.set_awaiting_plate_clear(printer_id, True)
  6223. # MQTT relay - publish print complete
  6224. try:
  6225. printer_info = printer_manager.get_printer(printer_id)
  6226. if printer_info:
  6227. await mqtt_relay.on_print_complete(
  6228. printer_id,
  6229. printer_info.name,
  6230. printer_info.serial_number,
  6231. data.get("filename", ""),
  6232. data.get("subtask_name", ""),
  6233. data.get("status", "completed"),
  6234. )
  6235. except Exception:
  6236. pass # Don't fail print complete callback if MQTT fails
  6237. filename = data.get("filename", "")
  6238. subtask_name = data.get("subtask_name", "")
  6239. if not filename and not subtask_name:
  6240. logger.warning("Print complete without filename or subtask_name")
  6241. return
  6242. logger.info("Print complete - filename: %s, subtask: %s, status: %s", filename, subtask_name, data.get("status"))
  6243. # Build list of possible keys to try (matching how they were registered in on_print_start)
  6244. possible_keys = []
  6245. # Try subtask_name variations first (most reliable for matching)
  6246. if subtask_name:
  6247. possible_keys.append((printer_id, f"{subtask_name}.3mf"))
  6248. possible_keys.append((printer_id, f"{subtask_name}.gcode.3mf"))
  6249. possible_keys.append((printer_id, subtask_name))
  6250. # Try filename variations
  6251. if filename:
  6252. # Extract just the filename if it's a path
  6253. fname = filename.split("/")[-1] if "/" in filename else filename
  6254. if fname.endswith(".3mf"):
  6255. possible_keys.append((printer_id, fname))
  6256. elif fname.endswith(".gcode"):
  6257. base_name = fname.rsplit(".", 1)[0]
  6258. possible_keys.append((printer_id, f"{base_name}.gcode.3mf"))
  6259. possible_keys.append((printer_id, f"{base_name}.3mf"))
  6260. possible_keys.append((printer_id, fname))
  6261. else:
  6262. possible_keys.append((printer_id, f"{fname}.gcode.3mf"))
  6263. possible_keys.append((printer_id, f"{fname}.3mf"))
  6264. possible_keys.append((printer_id, fname))
  6265. # Also try full path versions
  6266. if filename.endswith(".3mf"):
  6267. possible_keys.append((printer_id, filename))
  6268. elif filename.endswith(".gcode"):
  6269. base_name = filename.rsplit(".", 1)[0]
  6270. possible_keys.append((printer_id, f"{base_name}.3mf"))
  6271. possible_keys.append((printer_id, filename))
  6272. else:
  6273. possible_keys.append((printer_id, f"{filename}.3mf"))
  6274. possible_keys.append((printer_id, filename))
  6275. # Find the archive for this print
  6276. logger.info("Looking for archive in _active_prints, keys to try: %s...", possible_keys[:5])
  6277. logger.info("Current _active_prints: %s", list(_active_prints.keys()))
  6278. archive_id = None
  6279. for key in possible_keys:
  6280. archive_id = _active_prints.pop(key, None)
  6281. if archive_id:
  6282. logger.info("Found archive %s with key %s", archive_id, key)
  6283. # Also clean up any other keys pointing to this archive
  6284. keys_to_remove = [k for k, v in _active_prints.items() if v == archive_id]
  6285. for k in keys_to_remove:
  6286. _active_prints.pop(k, None)
  6287. break
  6288. if not archive_id:
  6289. # Try to find by filename or subtask_name if not tracked (for prints started before app)
  6290. async with async_session() as db:
  6291. from backend.app.models.archive import PrintArchive
  6292. # Try matching by subtask_name (stored as print_name) first
  6293. if subtask_name:
  6294. result = await db.execute(
  6295. select(PrintArchive)
  6296. .where(PrintArchive.printer_id == printer_id)
  6297. .where(PrintArchive.status == "printing")
  6298. .where(
  6299. or_(
  6300. PrintArchive.print_name.ilike(f"%{subtask_name}%"),
  6301. PrintArchive.filename.ilike(f"%{subtask_name}%"),
  6302. )
  6303. )
  6304. .order_by(PrintArchive.created_at.desc())
  6305. .limit(1)
  6306. )
  6307. archive = result.scalar_one_or_none()
  6308. if archive:
  6309. archive_id = archive.id
  6310. logger.info("Found archive %s by subtask_name match: %s", archive_id, subtask_name)
  6311. # Also try by filename
  6312. if not archive_id and filename:
  6313. result = await db.execute(
  6314. select(PrintArchive)
  6315. .where(PrintArchive.printer_id == printer_id)
  6316. .where(PrintArchive.filename == filename)
  6317. .where(PrintArchive.status == "printing")
  6318. .order_by(PrintArchive.created_at.desc())
  6319. .limit(1)
  6320. )
  6321. archive = result.scalar_one_or_none()
  6322. if archive:
  6323. archive_id = archive.id
  6324. # Cleanup: delete uploaded file from printer SD card to prevent phantom prints (Issue #374, #1542)
  6325. # The print scheduler uploads files to the SD card root (/). Some printers (e.g. P1S, A1)
  6326. # auto-start files found in root on power cycle, causing ghost prints.
  6327. # Must run before the archive_id early-return so it executes even when archiving is disabled.
  6328. try:
  6329. if subtask_name:
  6330. archive_filename: str | None = None
  6331. async with async_session() as db:
  6332. from backend.app.models.archive import PrintArchive
  6333. from backend.app.models.printer import Printer
  6334. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  6335. printer = result.scalar_one_or_none()
  6336. if archive_id:
  6337. archive_row = await db.execute(select(PrintArchive.filename).where(PrintArchive.id == archive_id))
  6338. archive_filename = archive_row.scalar_one_or_none()
  6339. if printer:
  6340. from backend.app.services.bambu_ftp import DeleteResult, delete_file_async
  6341. from backend.app.utils.filename import derive_remote_filename
  6342. # Primary candidate: the exact path the dispatcher uploaded to
  6343. # (derived from archive.filename via the same rule as upload).
  6344. # Without it, a library row that ended up with a doubled
  6345. # .gcode.3mf (#1542) leaves the real file behind because the
  6346. # subtask_name + ext fallbacks below don't match what's on the
  6347. # SD card. Fallbacks remain for archive-less prints (subtask
  6348. # never resolved to an archive) and for older naming variants.
  6349. candidate_paths: list[str] = []
  6350. if archive_filename:
  6351. candidate_paths.append(f"/{derive_remote_filename(archive_filename)}")
  6352. for ext in (".3mf", ".gcode"):
  6353. fallback = f"/{subtask_name}{ext}"
  6354. if fallback not in candidate_paths:
  6355. candidate_paths.append(fallback)
  6356. # Three outcomes track across all candidates so the final log
  6357. # line reflects what actually happened. The A1 in #1721 always
  6358. # ends here with ``any_not_found=True`` and the others False
  6359. # — its firmware auto-cleans the SD card before our cleanup
  6360. # runs, every candidate FTP-DELE returns 550, and the old
  6361. # code burned 3 retries × 2 s × 3 candidates per print
  6362. # logging a misleading "may linger" WARNING on a successful
  6363. # print.
  6364. any_deleted = False
  6365. any_real_failure = False
  6366. any_not_found = False
  6367. for remote_path in candidate_paths:
  6368. # Retry only the FAILED case — 550 NOT_FOUND will never
  6369. # recover by waiting, so a "file isn't here" answer
  6370. # advances immediately to the next candidate without
  6371. # consuming the retry budget.
  6372. for attempt in range(1, 4):
  6373. try:
  6374. delete_result = await delete_file_async(
  6375. printer.ip_address,
  6376. printer.access_code,
  6377. remote_path,
  6378. printer_model=printer.model,
  6379. )
  6380. except Exception as e:
  6381. delete_result = DeleteResult.FAILED
  6382. logger.warning(
  6383. "SD card cleanup attempt %d/3 raised for %s: %s",
  6384. attempt,
  6385. remote_path,
  6386. e,
  6387. )
  6388. if delete_result == DeleteResult.DELETED:
  6389. any_deleted = True
  6390. logger.info("Deleted %s from printer %s SD card", remote_path, printer.name)
  6391. break
  6392. if delete_result == DeleteResult.NOT_FOUND:
  6393. any_not_found = True
  6394. break # 550 will not recover; try next candidate
  6395. # FAILED: real error — retry with backoff, then give up
  6396. if attempt < 3:
  6397. await asyncio.sleep(2)
  6398. else:
  6399. any_real_failure = True
  6400. logger.warning(
  6401. "SD card cleanup failed after 3 attempts for %s "
  6402. "(network/auth/transient error — file may linger on SD card)",
  6403. remote_path,
  6404. )
  6405. if not any_deleted and not any_real_failure and any_not_found:
  6406. # Every candidate said "not here." Either the printer
  6407. # firmware swept the SD card itself (common on A1) or the
  6408. # dispatcher's upload path doesn't match our candidate
  6409. # rule. Either way: nothing to clean up, no warning.
  6410. logger.debug(
  6411. "SD card cleanup: nothing to delete on %s — every candidate returned 550 "
  6412. "(printer likely self-cleaned)",
  6413. printer.name,
  6414. )
  6415. except Exception as e:
  6416. logger.warning("SD card file cleanup failed for printer %s: %s", printer_id, e)
  6417. log_timing("SD card cleanup")
  6418. # Update queue item status early — must run before the archive_id early-return
  6419. # so queue items don't get stuck in "printing" when archive lookup fails.
  6420. # Uses run_with_retry to handle SQLite "database is locked" errors (#897).
  6421. queue_item_id = None
  6422. billing_run_id: str | None = None
  6423. billing_user_id: int | None = None
  6424. billing_cost_center_id: int | None = None
  6425. billing_plate_id: int | None = None
  6426. queue_status = None
  6427. queue_auto_off = False
  6428. try:
  6429. from backend.app.core.database import run_with_retry
  6430. from backend.app.models.print_queue import PrintQueueItem
  6431. async def _update_queue_status(db):
  6432. nonlocal billing_run_id, billing_user_id, billing_cost_center_id, billing_plate_id
  6433. nonlocal queue_item_id, queue_status, queue_auto_off
  6434. result = await db.execute(
  6435. select(PrintQueueItem)
  6436. .where(PrintQueueItem.printer_id == printer_id)
  6437. .where(PrintQueueItem.status == "printing")
  6438. )
  6439. printing_items = list(result.scalars().all())
  6440. if len(printing_items) > 1:
  6441. logger.warning(
  6442. "BUG: Multiple queue items in 'printing' status for printer %s: %s",
  6443. printer_id,
  6444. [(i.id, i.archive_id, i.library_file_id) for i in printing_items],
  6445. )
  6446. item = printing_items[0] if printing_items else None
  6447. if item is not None and not await _completion_belongs_to_queue_item(db, item, data):
  6448. return
  6449. if item:
  6450. queue_status = data.get("status", "completed")
  6451. # MQTT sends "aborted" for cancelled prints; normalise to
  6452. # "cancelled" so it matches the queue schema Literal.
  6453. if queue_status == "aborted":
  6454. queue_status = "cancelled"
  6455. item.status = queue_status
  6456. item.completed_at = datetime.now(timezone.utc)
  6457. if queue_status == "failed" and not item.error_message:
  6458. item.error_message = _format_hms_error_summary(data.get("hms_errors") or [])
  6459. # Bump usage counters on the source library file so admins can
  6460. # sort by "last printed" and (eventually) auto-purge stale
  6461. # files — #1008.
  6462. await _bump_library_file_usage_if_completed(db, item, queue_status)
  6463. await db.commit()
  6464. queue_item_id = item.id
  6465. billing_run_id = item.billing_run_id
  6466. billing_user_id = item.created_by_id
  6467. billing_cost_center_id = item.cost_center_id
  6468. billing_plate_id = item.plate_id
  6469. queue_auto_off = item.auto_off_after
  6470. logger.info("Updated queue item %s status to %s", item.id, queue_status)
  6471. await run_with_retry(_update_queue_status, label="queue status update")
  6472. # Post-commit side effects (notifications, MQTT relay, auto-off) use
  6473. # their own sessions and have their own error handling — no retry needed.
  6474. if queue_item_id is not None:
  6475. # Batch orders (#342): this run may have been the last one an order
  6476. # owed. Re-evaluate here rather than lazily on read, so a finished
  6477. # order reports itself complete without someone opening the page.
  6478. try:
  6479. from backend.app.services.print_batch import refresh_batch_status_for_item
  6480. async with async_session() as db:
  6481. await refresh_batch_status_for_item(db, queue_item_id)
  6482. await db.commit()
  6483. except Exception as e:
  6484. logger.warning("[BATCH] Failed to refresh batch status for queue item %s: %s", queue_item_id, e)
  6485. # MQTT relay - publish queue job completed
  6486. try:
  6487. printer_info = printer_manager.get_printer(printer_id)
  6488. await mqtt_relay.on_queue_job_completed(
  6489. job_id=queue_item_id,
  6490. filename=filename or subtask_name,
  6491. printer_id=printer_id,
  6492. printer_name=printer_info.name if printer_info else "Unknown",
  6493. status=queue_status,
  6494. )
  6495. except Exception:
  6496. pass # Don't fail if MQTT fails
  6497. # Check if queue is now empty and send notification
  6498. try:
  6499. from sqlalchemy import func as sa_func
  6500. async with async_session() as db:
  6501. count_result = await db.execute(
  6502. select(sa_func.count(PrintQueueItem.id)).where(PrintQueueItem.status == "pending")
  6503. )
  6504. pending_count = count_result.scalar() or 0
  6505. if pending_count == 0:
  6506. today_start = datetime.now(timezone.utc).replace(hour=0, minute=0, second=0, microsecond=0)
  6507. completed_result = await db.execute(
  6508. select(sa_func.count(PrintQueueItem.id)).where(
  6509. PrintQueueItem.status.in_(["completed", "failed", "skipped"]),
  6510. PrintQueueItem.completed_at >= today_start,
  6511. )
  6512. )
  6513. completed_count = completed_result.scalar() or 1
  6514. await notification_service.on_queue_completed(
  6515. completed_count=completed_count,
  6516. db=db,
  6517. )
  6518. except Exception:
  6519. pass # Don't fail if notification fails
  6520. # Handle auto_off_after - power off printer if the queue item opted
  6521. # in. Delegates to the smart-plug manager so the off honours each
  6522. # plug's configured strategy (time delay or temperature threshold),
  6523. # is cancelled if the printer starts printing again, and never cuts
  6524. # power on a loaded print (#1890). Previously an inline block here
  6525. # hardcoded a 50°C / 600s cooldown wait and powered off on the
  6526. # timeout regardless of print state — cutting a touchscreen reprint.
  6527. if queue_auto_off:
  6528. try:
  6529. async with async_session() as db:
  6530. await smart_plug_manager.schedule_off_after_queue_job(printer_id, db)
  6531. except Exception as e:
  6532. logger.warning("Failed to schedule queue auto-off for printer %s: %s", printer_id, e)
  6533. except Exception as e:
  6534. logging.getLogger(__name__).warning(f"Queue item update failed: {e}")
  6535. log_timing("Queue item update")
  6536. # Register bed cooldown waiter (event-driven via on_bed_temp_update callback).
  6537. # Must run before archive_id early-return so it fires for all prints (including
  6538. # prints started from BambuStudio/touchscreen that have no archive).
  6539. if data.get("status") == "completed":
  6540. try:
  6541. from backend.app.api.routes.settings import get_setting
  6542. async with async_session() as db:
  6543. threshold_str = await get_setting(db, "bed_cooled_threshold")
  6544. threshold = float(threshold_str) if threshold_str else 35.0
  6545. # Check if any provider has on_bed_cooled enabled (skip registration if none)
  6546. async with async_session() as db:
  6547. providers = await notification_service._get_providers_for_event(db, "on_bed_cooled", printer_id)
  6548. if providers:
  6549. _bed_cool_waiters[printer_id] = {
  6550. "threshold": threshold,
  6551. "filename": filename or subtask_name or "",
  6552. "registered_at": time.time(),
  6553. }
  6554. logger.info(
  6555. "[BED-COOL] Registered waiter for printer %s (threshold: %.0f°C)",
  6556. printer_id,
  6557. threshold,
  6558. )
  6559. else:
  6560. logger.debug("[BED-COOL] No providers enabled for bed_cooled on printer %s", printer_id)
  6561. except Exception as e:
  6562. logger.warning("[BED-COOL] Failed to register waiter: %s", e)
  6563. # Capture the slicer estimate before usage tracking runs. The tracker may
  6564. # update archive.cost with this run's measured cost; billing partial runs
  6565. # against that already-partial value would discount the charge twice.
  6566. billing_planned_grams: float | None = None
  6567. billing_base_cost: float | None = None
  6568. if archive_id:
  6569. try:
  6570. async with async_session() as db:
  6571. from backend.app.models.archive import PrintArchive
  6572. billing_archive = await db.get(PrintArchive, archive_id)
  6573. if billing_archive:
  6574. billing_path = (
  6575. app_settings.base_dir / billing_archive.file_path if billing_archive.file_path else None
  6576. ) # SEC-PATH-OK: archive.file_path is DB-stored, internally generated
  6577. billing_planned_grams, billing_base_cost = _plate_scoped_run_estimate(
  6578. billing_archive,
  6579. billing_path,
  6580. billing_plate_id if billing_plate_id is not None else _get_start_plate_id(archive_id),
  6581. )
  6582. except Exception as e:
  6583. logger.warning("[FINANCE] Failed to capture planned usage for archive %s: %s", archive_id, e)
  6584. # --- Track filament consumption (must run before archive_id early-return so usage
  6585. # is recorded even when auto-archive is disabled) ---
  6586. usage_results: list[dict] = []
  6587. # Prefer ams_mapping captured from MQTT request topic (works for all print sources)
  6588. stored_ams_mapping = data.get("ams_mapping")
  6589. # Fallback to _print_ams_mappings for queue/reprint (set before print starts)
  6590. if not stored_ams_mapping and archive_id:
  6591. stored_ams_mapping = _print_ams_mappings.pop(archive_id, None)
  6592. # Always drain the plate_id register on completion — the session already
  6593. # consumed it at print-start injection; leaving it would leak into the next
  6594. # print on the same archive_id (rare but possible with reprints) (#1697).
  6595. # Capture the popped value so the completion notification can scope the
  6596. # archive-level (summed-across-plates per #1593) filament + time totals
  6597. # down to the single plate that was actually printed (#1785).
  6598. notify_plate_id: int | None = None
  6599. if archive_id:
  6600. notify_plate_id = _print_plate_ids.pop(archive_id, None)
  6601. # Internal inventory: track AMS remain% deltas (skip if Spoolman handles usage)
  6602. try:
  6603. async with async_session() as db:
  6604. from backend.app.api.routes.settings import get_setting
  6605. _spoolman_on = await get_setting(db, "spoolman_enabled")
  6606. if not _spoolman_on or _spoolman_on.lower() != "true":
  6607. from backend.app.services.usage_tracker import on_print_complete as usage_on_print_complete
  6608. async with async_session() as db:
  6609. usage_results = await usage_on_print_complete(
  6610. printer_id,
  6611. data,
  6612. printer_manager,
  6613. db,
  6614. archive_id=archive_id,
  6615. ams_mapping=stored_ams_mapping,
  6616. )
  6617. if usage_results:
  6618. await ws_manager.broadcast(
  6619. {
  6620. "type": "spool_usage_logged",
  6621. "printer_id": printer_id,
  6622. "usage": usage_results,
  6623. }
  6624. )
  6625. log_timing("Usage tracker")
  6626. except Exception as e:
  6627. logger.warning("Usage tracker on_print_complete failed: %s", e)
  6628. # Drop the print-start context unconditionally — the Spoolman branch above
  6629. # skips the internal tracker entirely, so nothing else would clear what
  6630. # print start captured, and a row surviving its print would be restored
  6631. # onto the next one after a restart.
  6632. try:
  6633. from backend.app.services.usage_tracker import discard_session
  6634. async with async_session() as db:
  6635. await discard_session(db, printer_id)
  6636. except Exception as e:
  6637. logger.warning("Failed to clear persisted print session for printer %s: %s", printer_id, e)
  6638. # Spoolman: report filament usage (requires archive_id for tracking data lookup)
  6639. if archive_id:
  6640. if data.get("status") == "completed":
  6641. try:
  6642. await _report_spoolman_usage(printer_id, archive_id)
  6643. log_timing("Spoolman usage report")
  6644. except Exception as e:
  6645. logger.warning("Spoolman usage reporting failed: %s", e)
  6646. else:
  6647. # Report partial usage if tracking data exists (only stored when weight sync is disabled)
  6648. try:
  6649. async with async_session() as db:
  6650. await _cleanup_spoolman_tracking(
  6651. printer_id,
  6652. archive_id,
  6653. db,
  6654. last_layer_num=data.get("last_layer_num"),
  6655. last_progress=data.get("last_progress"),
  6656. )
  6657. except Exception as e:
  6658. logger.debug("[SPOOLMAN] Cleanup failed: %s", e)
  6659. log_timing("Filament usage tracking")
  6660. if not archive_id:
  6661. # The printer's own calibration run has no archive by design, so this
  6662. # arrives here every time one finishes. Returning before the no-archive
  6663. # notification is not just noise control: that path attributes an
  6664. # unmatched completion to any queue item this printer finished in the
  6665. # last five minutes, which for a calibration that runs alongside a real
  6666. # print means emailing its owner that their print is done, twice and
  6667. # early. Everything above this point has already run — the plate-clear
  6668. # gate, the queue reconciliation, the SD-card cleanup — so only the
  6669. # notification is skipped.
  6670. if is_internal_printer_job(filename, subtask_name):
  6671. logger.info(
  6672. "[CALLBACK] Internal printer job completed, no notification: filename=%s, subtask=%s",
  6673. filename,
  6674. subtask_name,
  6675. )
  6676. return
  6677. logger.warning("Could not find archive for print complete: filename=%s, subtask=%s", filename, subtask_name)
  6678. # Still send print-complete/failed/stopped notifications even without an archive.
  6679. # Try to enrich with queue/library-file data so user-specific emails work too.
  6680. async def _notify_no_archive():
  6681. try:
  6682. async with async_session() as db:
  6683. from backend.app.models.library import LibraryFile
  6684. from backend.app.models.print_queue import PrintQueueItem
  6685. from backend.app.models.printer import Printer
  6686. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  6687. printer_obj = result.scalar_one_or_none()
  6688. p_name = printer_obj.name if printer_obj else f"Printer {printer_id}"
  6689. # Try to find the most-recent queue item for this printer so we can
  6690. # recover created_by_id and estimated print time.
  6691. # NOTE: By the time this task runs the queue item status has already
  6692. # been updated to a terminal state (completed/failed/cancelled), so
  6693. # we look for recently-completed items (within the last 5 minutes).
  6694. no_archive_data: dict | None = None
  6695. try:
  6696. cutoff = datetime.now(timezone.utc) - timedelta(minutes=5)
  6697. q_result = await db.execute(
  6698. select(PrintQueueItem)
  6699. .where(PrintQueueItem.printer_id == printer_id)
  6700. .where(PrintQueueItem.status.in_(["completed", "failed", "cancelled"]))
  6701. .where(PrintQueueItem.completed_at >= cutoff)
  6702. .order_by(PrintQueueItem.completed_at.desc())
  6703. .limit(1)
  6704. )
  6705. queue_item = q_result.scalar_one_or_none()
  6706. if queue_item:
  6707. no_archive_data = {"created_by_id": queue_item.created_by_id}
  6708. # Pull estimated time from library file when available
  6709. if queue_item.library_file_id:
  6710. lib_result = await db.execute(
  6711. select(LibraryFile).where(LibraryFile.id == queue_item.library_file_id)
  6712. )
  6713. lib_file = lib_result.scalar_one_or_none()
  6714. if lib_file and lib_file.print_time_seconds:
  6715. no_archive_data["print_time_seconds"] = lib_file.print_time_seconds
  6716. except Exception as lookup_err:
  6717. logger.debug(
  6718. "[NOTIFY-BG] Could not look up queue item for no-archive notification: %s", lookup_err
  6719. )
  6720. # Enrich with usage tracker results (captured in enclosing scope)
  6721. if usage_results:
  6722. if no_archive_data is None:
  6723. no_archive_data = {}
  6724. total_from_usage = sum(r.get("weight_used", 0) for r in usage_results)
  6725. if total_from_usage > 0:
  6726. no_archive_data["actual_filament_grams"] = round(total_from_usage, 1)
  6727. no_archive_data["usage_results"] = usage_results
  6728. # Try MQTT remaining_time for print duration when no queue/library data
  6729. if no_archive_data and not no_archive_data.get("print_time_seconds"):
  6730. mqtt_remaining = data.get("remaining_time")
  6731. if mqtt_remaining and isinstance(mqtt_remaining, (int, float)) and mqtt_remaining > 0:
  6732. no_archive_data["print_time_seconds"] = int(mqtt_remaining)
  6733. ps = data.get("status", "completed")
  6734. logger.info(
  6735. "[NOTIFY-BG] Sending notification without archive: printer=%s, status=%s", printer_id, ps
  6736. )
  6737. if not await _kill_switch_notification_already_sent(kill_switch_notification_task):
  6738. await notification_service.on_print_complete(
  6739. printer_id, p_name, ps, data, db, archive_data=no_archive_data
  6740. )
  6741. else:
  6742. logger.info("[NOTIFY-BG] Skipped duplicate kill-switch provider notification")
  6743. # Send user-specific email if we have a created_by_id
  6744. if no_archive_data and no_archive_data.get("created_by_id"):
  6745. raw_filename = data.get("subtask_name") or data.get("filename", "Unknown")
  6746. await _dispatch_user_print_email(
  6747. ps,
  6748. no_archive_data["created_by_id"],
  6749. p_name,
  6750. raw_filename,
  6751. db,
  6752. )
  6753. logger.info("[NOTIFY-BG] Completed (no-archive path)")
  6754. except Exception as e:
  6755. logger.warning("[NOTIFY-BG] Failed to send notification without archive: %s", e, exc_info=True)
  6756. spawn_background_task(_notify_no_archive(), name="notify-no-archive")
  6757. return
  6758. log_timing("Archive lookup")
  6759. # Update archive status
  6760. logger.info("[ARCHIVE] Updating archive %s status...", archive_id)
  6761. try:
  6762. async with async_session() as db:
  6763. service = ArchiveService(db)
  6764. status = data.get("status", "completed")
  6765. hms_errors = data.get("hms_errors", []) if status == "failed" else None
  6766. if hms_errors:
  6767. logger.info("[ARCHIVE] HMS errors at failure: %s", hms_errors)
  6768. failure_reason = derive_failure_reason(status, hms_errors)
  6769. if data.get("_reconciled"):
  6770. # A reconciled completion closes out a stale archive at
  6771. # reconnect — it is not a user action, so don't mislabel it
  6772. # "userCancelled". It shares the stale-cleanup path's key
  6773. # (issue #2974) and records that the real end time is unknown,
  6774. # which is also why its logged duration is 0 (#2592).
  6775. failure_reason = "noStatusUpdate"
  6776. if failure_reason:
  6777. logger.info("[ARCHIVE] failure_reason=%r (status=%s)", failure_reason, status)
  6778. elif status == "failed" and hms_errors:
  6779. logger.info("[ARCHIVE] HMS errors present but none matched a known failure-reason short code")
  6780. await service.update_archive_status(
  6781. archive_id,
  6782. status=status,
  6783. completed_at=(
  6784. datetime.now(timezone.utc) if status in ("completed", "failed", "aborted", "cancelled") else None
  6785. ),
  6786. failure_reason=failure_reason,
  6787. )
  6788. logger.info(
  6789. "[ARCHIVE] Archive %s status updated to %s, failure_reason=%s", archive_id, status, failure_reason
  6790. )
  6791. await ws_manager.send_archive_updated(
  6792. {
  6793. "id": archive_id,
  6794. "status": status,
  6795. }
  6796. )
  6797. logger.info("[ARCHIVE] WebSocket notification sent for archive %s", archive_id)
  6798. # MQTT relay - publish archive updated
  6799. try:
  6800. await mqtt_relay.on_archive_updated(
  6801. archive_id=archive_id,
  6802. print_name=filename or subtask_name,
  6803. status=status,
  6804. )
  6805. except Exception:
  6806. pass # Don't fail if MQTT fails
  6807. except Exception as e:
  6808. logger.error("[ARCHIVE] Failed to update archive %s status: %s", archive_id, e, exc_info=True)
  6809. # Continue with other operations even if archive update fails
  6810. log_timing("Archive status update")
  6811. # Apply finance wallet charge or release reservations once. For all partial
  6812. # terminal states (failed, aborted at the printer display, or cancelled via
  6813. # Bambuddy) use this run's measured spool delta, falling back to the last
  6814. # valid printer progress. PrintArchive.filament_used_grams is the slicer
  6815. # estimate and therefore cannot represent an interrupted run.
  6816. try:
  6817. if data.get("status") in ("completed", "failed", "aborted", "cancelled"):
  6818. async with async_session() as db:
  6819. from backend.app.models.archive import PrintArchive
  6820. from backend.app.services.finance_billing import apply_print_charge_for_archive
  6821. archive = await db.get(PrintArchive, archive_id)
  6822. if archive and billing_run_id is None:
  6823. billing_run_id = getattr(archive, "billing_run_id", None)
  6824. if archive and archive.created_by_id is None and _print_user_info:
  6825. archive.created_by_id = _print_user_info.get("user_id")
  6826. await db.flush()
  6827. run_status = data.get("status", "completed")
  6828. last_progress = data.get("last_progress")
  6829. if last_progress is None:
  6830. last_progress = data.get("progress")
  6831. actual_run_grams = _compute_run_filament_grams(
  6832. run_status,
  6833. billing_planned_grams,
  6834. last_progress,
  6835. usage_results,
  6836. )
  6837. filament_usage = (actual_run_grams, billing_planned_grams) if run_status != "completed" else None
  6838. in_memory_cost_center_id = _print_cost_center_ids.pop(archive_id, None)
  6839. charged = await apply_print_charge_for_archive(
  6840. db,
  6841. archive_id,
  6842. charged_user_id=billing_user_id,
  6843. cost_center_id=(
  6844. billing_cost_center_id if billing_cost_center_id is not None else in_memory_cost_center_id
  6845. ),
  6846. print_queue_id=queue_item_id,
  6847. print_run_id=billing_run_id,
  6848. base_cost_override=billing_base_cost,
  6849. filament_usage=filament_usage,
  6850. )
  6851. await db.commit()
  6852. if charged:
  6853. logger.info("[FINANCE] Applied print charge for archive %s", archive_id)
  6854. except Exception as e:
  6855. logger.warning("[FINANCE] Failed to apply print charge for archive %s: %s", archive_id, e)
  6856. printer_info = printer_manager.get_printer(printer_id)
  6857. billing_printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
  6858. billing_filename = filename or subtask_name or "Unknown"
  6859. billing_error = str(e)
  6860. try:
  6861. await ws_manager.broadcast(
  6862. {
  6863. "type": "billing_charge_failed",
  6864. "printer_id": printer_id,
  6865. "printer_name": billing_printer_name,
  6866. "filename": billing_filename,
  6867. "archive_id": archive_id,
  6868. }
  6869. )
  6870. except Exception as notification_error:
  6871. logger.error(
  6872. "[FINANCE] Failed to broadcast billing error for archive %s: %s",
  6873. archive_id,
  6874. notification_error,
  6875. )
  6876. async def _notify_billing_charge_failed() -> None:
  6877. try:
  6878. async with async_session() as notification_db:
  6879. await notification_service.on_billing_charge_failed(
  6880. printer_id,
  6881. billing_printer_name,
  6882. billing_filename,
  6883. archive_id,
  6884. billing_error,
  6885. notification_db,
  6886. )
  6887. except Exception as provider_error:
  6888. logger.error(
  6889. "[FINANCE] Failed to send provider billing alert for archive %s: %s",
  6890. archive_id,
  6891. provider_error,
  6892. exc_info=True,
  6893. )
  6894. spawn_background_task(
  6895. _notify_billing_charge_failed(),
  6896. name=f"billing-charge-failed-{archive_id}",
  6897. )
  6898. log_timing("Finance charge update")
  6899. # Write independent print log entry (separate table, never touches archives)
  6900. try:
  6901. async with async_session() as db:
  6902. from backend.app.models.archive import PrintArchive
  6903. from backend.app.services.print_log import write_log_entry
  6904. archive = await db.get(PrintArchive, archive_id)
  6905. if archive:
  6906. # Back-fill created_by_id on reprint (#730): reprint reuses the
  6907. # source archive row rather than creating a new one, so an
  6908. # archive that was auto-created from a printer-initiated
  6909. # print (created_by_id=NULL) would otherwise stay unattributed
  6910. # forever. When we have a print-session user AND the archive
  6911. # has no attribution yet, credit the current user. Never
  6912. # overwrite an existing attribution — the original uploader
  6913. # keeps ownership.
  6914. _print_user_id = _print_user_info.get("user_id") if _print_user_info else None
  6915. if archive.created_by_id is None and _print_user_id is not None:
  6916. archive.created_by_id = _print_user_id
  6917. p_info = printer_manager.get_printer(printer_id)
  6918. # Per-run actuals — written to PrintLogEntry so stats reflect
  6919. # what THIS print actually used, not the source archive's
  6920. # first-run values (#1378). Helper handles the partial-print
  6921. # math (failed / cancelled / stopped get scaled to progress
  6922. # or to tracked spool deltas).
  6923. _run_status = data.get("status", "completed")
  6924. # #2614: scope the per-run estimate to the printed plate. For a
  6925. # multi-plate 3MF dispatched one plate at a time, the archive's
  6926. # filament/cost are the whole-file totals; the PrintLogEntry must
  6927. # reflect only this plate. No effect on single-plate archives (the
  6928. # plate estimate equals the whole-file value) or on the tracker
  6929. # path (measured spool deltas win in _compute_run_filament_grams).
  6930. _est_full_path = (
  6931. app_settings.base_dir / archive.file_path if archive.file_path else None
  6932. ) # SEC-PATH-OK: archive.file_path is DB-stored, internally generated
  6933. _est_grams, _est_cost = _plate_scoped_run_estimate(archive, _est_full_path)
  6934. _run_grams = _compute_run_filament_grams(
  6935. _run_status,
  6936. _est_grams,
  6937. data.get("last_progress", data.get("progress")),
  6938. usage_results,
  6939. )
  6940. # Per-run cost — prefer usage_results sum. For partial prints
  6941. # we deliberately skip the topup-to-estimate logic in
  6942. # usage_tracker (which assumes the print completed); the raw
  6943. # tracked-spool sum is closer to what THIS run actually cost.
  6944. _run_cost: float | None = None
  6945. if usage_results:
  6946. _run_cost = sum(r.get("cost") or 0 for r in usage_results) or None
  6947. if _run_cost is None and _run_status == "completed":
  6948. _run_cost = _est_cost
  6949. await write_log_entry(
  6950. db,
  6951. archive_id=archive.id,
  6952. # Captured by _update_queue_status above; None for
  6953. # printer-initiated prints with no queue row. Batch
  6954. # cost/energy roll-up joins on it (#342).
  6955. queue_item_id=queue_item_id,
  6956. status=_run_status,
  6957. print_name=archive.print_name,
  6958. printer_name=p_info.name if p_info else None,
  6959. printer_id=printer_id,
  6960. started_at=archive.started_at,
  6961. completed_at=archive.completed_at,
  6962. filament_type=archive.filament_type,
  6963. filament_color=archive.filament_color,
  6964. filament_used_grams=_run_grams,
  6965. cost=_run_cost,
  6966. failure_reason=archive.failure_reason,
  6967. thumbnail_path=archive.thumbnail_path,
  6968. created_by_id=archive.created_by_id,
  6969. created_by_username=_print_user_info.get("username") if _print_user_info else None,
  6970. # Reconciled completions have an unknown real end time —
  6971. # log 0 duration instead of the whole disconnect gap (#2592).
  6972. reconciled=bool(data.get("_reconciled")),
  6973. )
  6974. await db.commit()
  6975. logger.info("[PRINT_LOG] Log entry written for archive %s", archive_id)
  6976. except Exception as e:
  6977. logger.warning("[PRINT_LOG] Failed to write log entry for archive %s: %s", archive_id, e)
  6978. log_timing("Print log entry")
  6979. # Run slow operations as background tasks to avoid blocking the event loop
  6980. # These operations can take 5-10+ seconds and would freeze the UI if awaited
  6981. async def _background_energy_calculation():
  6982. """Calculate and save energy usage in background.
  6983. Reads the starting kWh from the archive row (#941: persisted so a mid-print
  6984. backend restart no longer loses per-print energy data).
  6985. """
  6986. try:
  6987. logger.info("[ENERGY-BG] Starting energy calculation for archive %s", archive_id)
  6988. async with async_session() as db:
  6989. from backend.app.models.archive import PrintArchive
  6990. archive = await db.get(PrintArchive, archive_id)
  6991. if archive is None:
  6992. logger.warning("[ENERGY-BG] Archive %s no longer exists", archive_id)
  6993. return
  6994. starting_kwh = archive.energy_start_kwh
  6995. if starting_kwh is None:
  6996. logger.info("[ENERGY-BG] No start kWh recorded for archive %s", archive_id)
  6997. return
  6998. candidates = await energy_plug_candidates(db, printer_id)
  6999. if not candidates:
  7000. logger.info("[ENERGY-BG] No smart plug for printer %s", printer_id)
  7001. return
  7002. # Same ordering as the start reading, so the delta below is
  7003. # against the counter that produced `starting_kwh` (#2859).
  7004. selected = await select_energy_reading(candidates, _get_plug_energy, db)
  7005. if selected is None:
  7006. logger.warning(
  7007. "[ENERGY-BG] No plug on printer %s reports a lifetime energy counter (tried: %s)",
  7008. printer_id,
  7009. ", ".join(plug.name for plug in candidates),
  7010. )
  7011. return
  7012. plug, energy = selected
  7013. logger.info("[ENERGY-BG] Energy response from plug '%s': %s", plug.name, energy)
  7014. energy_used = round(energy["total"] - starting_kwh, 4)
  7015. logger.info("[ENERGY-BG] Per-print energy: %s kWh", energy_used)
  7016. if energy_used < 0:
  7017. logger.warning(
  7018. "[ENERGY-BG] Negative energy delta for archive %s (start=%s, end=%s) — counter reset?",
  7019. archive_id,
  7020. starting_kwh,
  7021. energy["total"],
  7022. )
  7023. return
  7024. from backend.app.api.routes.settings import get_setting
  7025. energy_cost_per_kwh = await get_setting(db, "energy_cost_per_kwh")
  7026. cost_per_kwh = float(energy_cost_per_kwh) if energy_cost_per_kwh else 0.15
  7027. energy_cost_value = round(energy_used * cost_per_kwh, 3)
  7028. # First-run-only overwrite of archive.energy_kwh / energy_cost so a
  7029. # reprint doesn't visually clobber the source archive's energy data
  7030. # (#1378). Reprint energy lives in the matching PrintLogEntry below.
  7031. from sqlalchemy import func
  7032. from backend.app.models.print_log import PrintLogEntry
  7033. existing_runs = await db.scalar(
  7034. select(func.count(PrintLogEntry.id)).where(PrintLogEntry.archive_id == archive_id)
  7035. )
  7036. if (existing_runs or 0) <= 1:
  7037. # 0 = legacy archive that pre-dates per-run logging; 1 = the row
  7038. # we just wrote for THIS print. Either way it's the first run.
  7039. archive.energy_kwh = energy_used
  7040. archive.energy_cost = energy_cost_value
  7041. # Backfill the latest PrintLogEntry for this archive with energy
  7042. # (write_log_entry above ran before this background task completed,
  7043. # so energy fields are still NULL on that row).
  7044. latest_run = await db.execute(
  7045. select(PrintLogEntry)
  7046. .where(PrintLogEntry.archive_id == archive_id)
  7047. .order_by(PrintLogEntry.id.desc())
  7048. .limit(1)
  7049. )
  7050. run_row = latest_run.scalar_one_or_none()
  7051. if run_row is not None:
  7052. run_row.energy_kwh = energy_used
  7053. run_row.energy_cost = energy_cost_value
  7054. await db.commit()
  7055. logger.info("[ENERGY-BG] Saved: %s kWh, cost=%s", energy_used, energy_cost_value)
  7056. except Exception as e:
  7057. logger.warning("[ENERGY-BG] Failed: %s", e)
  7058. async def _background_finish_photo() -> str | None:
  7059. """Capture finish photo in background. Returns photo filename if captured."""
  7060. # #2547: set once this function has raised the plate itself (the
  7061. # timelapse path, where the moment producer returned without doing it).
  7062. # Declared out here so the `finally` can lower it again no matter where
  7063. # the capture below fails.
  7064. plate_restored_z: float | None = None
  7065. try:
  7066. logger.info("[PHOTO-BG] Starting finish photo capture for archive %s", archive_id)
  7067. from backend.app.api.routes.camera import _active_chamber_streams, _active_streams, get_buffered_frame
  7068. # Read phase: settings + printer + archive in a short session, released
  7069. # BEFORE the capture pipeline below. The capture (timelapse last-frame,
  7070. # stage-22 wait, external-camera grab, or a fresh RTSP shot) can take
  7071. # tens of seconds; holding this session across it pinned one pooled
  7072. # connection idle-in-transaction per finishing print (issue #2572).
  7073. async with async_session() as db:
  7074. from backend.app.api.routes.settings import get_setting
  7075. from backend.app.models.archive import PrintArchive
  7076. from backend.app.models.printer import Printer
  7077. capture_enabled = await get_setting(db, "capture_finish_photo")
  7078. if capture_enabled is not None and capture_enabled.lower() != "true":
  7079. return None
  7080. if not archive_id:
  7081. return None
  7082. printer = (await db.execute(select(Printer).where(Printer.id == printer_id))).scalar_one_or_none()
  7083. archive = (
  7084. await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  7085. ).scalar_one_or_none()
  7086. if not printer or not archive:
  7087. return None
  7088. import uuid
  7089. from datetime import datetime
  7090. from backend.app.utils.archive_paths import archive_dir as resolve_archive_dir
  7091. if not archive.file_path:
  7092. logger.warning("[PHOTO-BG] Archive %s has no file_path, using fallback dir", archive_id)
  7093. archive_dir = resolve_archive_dir(archive)
  7094. photo_filename = None
  7095. # Prefer the timelapse last-frame source when a timelapse was
  7096. # recording — it captures the moment after the toolhead parks
  7097. # but before the bed drops, which the live-camera grab below
  7098. # would miss (#1397). Skipped for external cameras (those have
  7099. # their own framing and don't see a Bambu timelapse). Only
  7100. # runs when the USER explicitly enabled timelapse for this
  7101. # print — #1721 removed Bambuddy's force-on at dispatch
  7102. # because it caused per-layer nozzle parking on Smooth-mode
  7103. # slicer profiles.
  7104. prefer_timelapse_source = bool(data.get("timelapse_was_active")) and not (
  7105. printer.external_camera_enabled and printer.external_camera_url
  7106. )
  7107. timelapse_still_pending = False
  7108. if prefer_timelapse_source:
  7109. photo_filename, timelapse_still_pending = await _capture_finish_photo_from_timelapse(
  7110. archive_id=archive_id,
  7111. archive_dir=archive_dir,
  7112. rotation=getattr(printer, "camera_rotation", 0),
  7113. )
  7114. # #1721: replacement framing path — on_finish_photo_moment
  7115. # pre-captured a frame at the stage-22 / FINISH edge (toolhead
  7116. # parked, bed not yet dropped) and cached the JPEG bytes in
  7117. # _stage22_finish_frames. Consume them now so the saved photo
  7118. # has the better framing instead of the post-bed-drop angle
  7119. # the live-camera fallback below would give.
  7120. if not photo_filename:
  7121. # #1790: on the FINISH-state fallback path the producer
  7122. # task is dispatched back-to-back with this consumer, so
  7123. # a bare pop would race past with an empty result and
  7124. # the RTSP fallback below would collide with the
  7125. # producer's still-in-flight grab (single-client RTSP
  7126. # on Bambu printers). Wait for the producer to finish
  7127. # or give up before touching the cache.
  7128. #
  7129. # #2547: 20s was enough when the producer only ever grabbed a
  7130. # frame. It now also raises the plate first, which costs the
  7131. # settle window before the grab even starts — so the budget has
  7132. # to cover settle + a worst-case 15s RTSP timeout, and still sit
  7133. # under the notification's own photo wait below.
  7134. in_flight = _stage22_finish_in_flight.pop(printer_id, None)
  7135. if in_flight is not None:
  7136. try:
  7137. await asyncio.wait_for(in_flight.wait(), timeout=_FINISH_PHOTO_PRODUCER_WAIT_SECONDS)
  7138. except asyncio.TimeoutError:
  7139. logger.warning(
  7140. "[PHOTO-BG] timed out waiting for stage-22 producer for printer %s — proceeding to fallback",
  7141. printer_id,
  7142. )
  7143. cached_frame = _stage22_finish_frames.pop(printer_id, None)
  7144. if cached_frame:
  7145. # Already rotated by the producer (#2708) — rotating again
  7146. # here would undo the fix on the banked-frame path, whose
  7147. # bytes reach the cache having been rotated once already.
  7148. photos_dir = archive_dir / "photos"
  7149. photos_dir.mkdir(parents=True, exist_ok=True)
  7150. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  7151. photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  7152. photo_path = photos_dir / photo_filename
  7153. await asyncio.to_thread(photo_path.write_bytes, cached_frame)
  7154. logger.info(
  7155. "[PHOTO-BG] Saved stage-22 pre-captured frame: %s (%d bytes)",
  7156. photo_filename,
  7157. len(cached_frame),
  7158. )
  7159. # #2547: the timelapse path reaches the live grab below whenever the
  7160. # video hasn't landed in time — the documented usual outcome on
  7161. # P1-series, where transfers are slowest. `on_finish_photo_moment`
  7162. # returned early for those prints without raising the plate, so
  7163. # without this the photo that actually ships in the notification is
  7164. # of an already-dropped plate: exactly the framing #1145/#1397/#1565
  7165. # asked us to fix. The archive still gets the better video frame
  7166. # later; this is about the image the user is sent.
  7167. #
  7168. # Gated on `timelapse_was_active` precisely because that is the
  7169. # condition under which the producer skipped. On every other path it
  7170. # has already raised and lowered the plate, and repeating that here
  7171. # would be a second pointless round trip.
  7172. if (
  7173. not photo_filename
  7174. and data.get("timelapse_was_active")
  7175. and not print_dispatch_context.end_gcode_injected(printer_id)
  7176. ):
  7177. try:
  7178. async with async_session() as db:
  7179. from backend.app.api.routes.settings import get_setting
  7180. restore_setting = await get_setting(db, "finish_photo_restore_plate")
  7181. if restore_setting is None or restore_setting.lower() == "true":
  7182. max_z = await _max_z_for_current_print(printer_id, data, logger)
  7183. if max_z is not None and not await _plate_restore_is_blocked_by_queue(printer_id):
  7184. if await _restore_plate_for_finish_photo(printer_id, max_z, logger):
  7185. plate_restored_z = max_z
  7186. except Exception as e:
  7187. logger.warning("[PLATE-RESTORE] printer %s: restore failed: %s", printer_id, e)
  7188. # Fallback chain: external camera → buffered live frame →
  7189. # fresh RTSP capture. Only runs if the timelapse path above
  7190. # didn't already produce a photo.
  7191. if not photo_filename:
  7192. if printer.external_camera_enabled and printer.external_camera_url:
  7193. logger.info("[PHOTO-BG] Using external camera")
  7194. from backend.app.api.routes.camera import live_frame_for_capture
  7195. from backend.app.services.external_camera import capture_frame
  7196. # #2707: the second half of the finish-photo failure — the
  7197. # pre-capture and this fallback both collided with the live
  7198. # view. None here continues down the fallback chain.
  7199. defer, buffered = live_frame_for_capture(printer_id)
  7200. if defer:
  7201. frame_data = buffered
  7202. else:
  7203. frame_data = await capture_frame(
  7204. printer.external_camera_url,
  7205. printer.external_camera_type or "mjpeg",
  7206. snapshot_url=printer.external_camera_snapshot_url,
  7207. )
  7208. if frame_data:
  7209. frame_data = _apply_camera_rotation(frame_data, printer, logger)
  7210. photos_dir = archive_dir / "photos"
  7211. photos_dir.mkdir(parents=True, exist_ok=True)
  7212. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  7213. photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  7214. photo_path = photos_dir / photo_filename
  7215. await asyncio.to_thread(photo_path.write_bytes, frame_data)
  7216. logger.info("[PHOTO-BG] Saved external camera frame: %s", photo_filename)
  7217. else:
  7218. # Check if camera stream is active - use buffered frame to avoid freeze
  7219. # Check both RTSP streams (_active_streams) and chamber image streams (_active_chamber_streams)
  7220. active_for_printer = [k for k in _active_streams if k.startswith(f"{printer_id}-")]
  7221. active_chamber_for_printer = [k for k in _active_chamber_streams if k.startswith(f"{printer_id}-")]
  7222. buffered_frame = get_buffered_frame(printer_id)
  7223. if (active_for_printer or active_chamber_for_printer) and buffered_frame:
  7224. # Use frame from active stream
  7225. logger.info("[PHOTO-BG] Using buffered frame from active stream")
  7226. buffered_frame = _apply_camera_rotation(buffered_frame, printer, logger)
  7227. photos_dir = archive_dir / "photos"
  7228. photos_dir.mkdir(parents=True, exist_ok=True)
  7229. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  7230. photo_filename = f"finish_{timestamp}_{uuid.uuid4().hex[:8]}.jpg"
  7231. photo_path = photos_dir / photo_filename
  7232. await asyncio.to_thread(photo_path.write_bytes, buffered_frame)
  7233. logger.info("[PHOTO-BG] Saved buffered frame: %s", photo_filename)
  7234. else:
  7235. # No active stream - capture new frame
  7236. from backend.app.services.camera import capture_finish_photo
  7237. photo_filename = await capture_finish_photo(
  7238. printer_id=printer_id,
  7239. ip_address=printer.ip_address,
  7240. access_code=printer.access_code,
  7241. model=printer.model,
  7242. archive_dir=archive_dir,
  7243. rotation=getattr(printer, "camera_rotation", 0),
  7244. )
  7245. # Write phase: attach the photo in a fresh short-lived session.
  7246. if photo_filename:
  7247. async with async_session() as db:
  7248. from backend.app.models.archive import PrintArchive
  7249. arch = await db.get(PrintArchive, archive_id)
  7250. if arch is not None:
  7251. photos = arch.photos or []
  7252. photos.append(photo_filename)
  7253. arch.photos = photos
  7254. await db.commit()
  7255. logger.info("[PHOTO-BG] Saved: %s", photo_filename)
  7256. # The short wait above is bounded so a slow printer can't hold up
  7257. # the print-complete notification, which is what the caller is
  7258. # blocking on. When it ran out with the video still on its way,
  7259. # keep waiting off to the side and add the better frame to the
  7260. # archive once it arrives (#2704 follow-up) — otherwise P1-series
  7261. # users, whose videos routinely take minutes to transfer, never get
  7262. # the pre-bed-drop framing this path exists to provide.
  7263. #
  7264. # Spawned here rather than at the point the wait gave up: both this
  7265. # function and the upgrade do a read-modify-write on `photos`, and
  7266. # the live-camera fallback above can take tens of seconds. Starting
  7267. # the upgrade before that write means the two can interleave and one
  7268. # silently drops the other's entry, leaving a JPEG on disk that the
  7269. # gallery never lists.
  7270. if timelapse_still_pending:
  7271. spawn_background_task(
  7272. _upgrade_finish_photo_from_timelapse(
  7273. archive_id, archive_dir, rotation=getattr(printer, "camera_rotation", 0)
  7274. ),
  7275. name=f"finish-photo-upgrade-{archive_id}",
  7276. )
  7277. return photo_filename
  7278. except Exception as e:
  7279. logger.warning("[PHOTO-BG] Failed: %s", e)
  7280. return None
  7281. finally:
  7282. # #2547: we raised the plate, so we owe the move back down — even if
  7283. # the capture in between threw. Otherwise the user finds the print
  7284. # pinned under the nozzle.
  7285. if plate_restored_z is not None:
  7286. try:
  7287. _park_plate_after_finish_photo(printer_id, plate_restored_z, logger)
  7288. except Exception as e:
  7289. logger.warning("[PLATE-RESTORE] printer %s: could not lower plate: %s", printer_id, e)
  7290. spawn_background_task(_background_energy_calculation(), name="background-energy-calc")
  7291. # Photo capture task - result will be used by notifications
  7292. photo_task = spawn_background_task(_background_finish_photo(), name="background-finish-photo")
  7293. log_timing("Background tasks scheduled (energy, photo)")
  7294. # Also run smart plug, notifications, and maintenance as background tasks
  7295. print_status = data.get("status", "completed")
  7296. async def _background_smart_plug():
  7297. """Handle smart plug automation in background."""
  7298. try:
  7299. logger.info("[AUTO-OFF-BG] Starting smart plug automation for printer %s", printer_id)
  7300. async with async_session() as db:
  7301. await smart_plug_manager.on_print_complete(printer_id, print_status, db)
  7302. logger.info("[AUTO-OFF-BG] Completed")
  7303. except Exception as e:
  7304. logger.warning("[AUTO-OFF-BG] Failed: %s", e)
  7305. async def _background_notifications(finish_photo_filename: str | None = None):
  7306. """Send print complete notifications in background."""
  7307. try:
  7308. logger.info(
  7309. "[NOTIFY-BG] Starting notifications for printer %s, photo=%s", printer_id, finish_photo_filename
  7310. )
  7311. async with async_session() as db:
  7312. from backend.app.models.archive import PrintArchive
  7313. from backend.app.models.printer import Printer
  7314. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  7315. printer = result.scalar_one_or_none()
  7316. printer_name = printer.name if printer else f"Printer {printer_id}"
  7317. archive_data = None
  7318. if archive_id:
  7319. archive_result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  7320. archive = archive_result.scalar_one_or_none()
  7321. if archive:
  7322. # Actual elapsed time from started_at/completed_at when both are
  7323. # populated (every terminal status sets completed_at after #1198).
  7324. # Falls back to None so the notification path can decide whether to
  7325. # render the slicer estimate as a last resort.
  7326. actual_time_seconds = None
  7327. if archive.started_at and archive.completed_at:
  7328. elapsed = (archive.completed_at - archive.started_at).total_seconds()
  7329. if elapsed > 0:
  7330. actual_time_seconds = int(elapsed)
  7331. archive_data = {
  7332. "print_time_seconds": archive.print_time_seconds,
  7333. "actual_time_seconds": actual_time_seconds,
  7334. "actual_filament_grams": archive.filament_used_grams,
  7335. "failure_reason": archive.failure_reason,
  7336. "created_by_id": archive.created_by_id,
  7337. }
  7338. # Scale filament usage for partial prints
  7339. if print_status != "completed" and archive.filament_used_grams:
  7340. progress = data.get("progress") or 0
  7341. scale = _partial_progress_scale(progress)
  7342. archive_data["actual_filament_grams"] = round(archive.filament_used_grams * scale, 1)
  7343. archive_data["progress"] = progress
  7344. # Pass per-slot data from archive.extra_data
  7345. if archive.extra_data and archive.extra_data.get("filament_slots"):
  7346. slots = archive.extra_data["filament_slots"]
  7347. if print_status != "completed":
  7348. scale = _partial_progress_scale(data.get("progress"))
  7349. slots = [{**s, "used_g": round(s["used_g"] * scale, 1)} for s in slots]
  7350. archive_data["filament_slots"] = slots
  7351. # Scope project-summed totals down to the plate that was
  7352. # actually printed — see _scope_notification_archive_data_to_plate
  7353. # for the why (#1785).
  7354. archive_data = _scope_notification_archive_data_to_plate(
  7355. archive_data,
  7356. archive.file_path,
  7357. notify_plate_id,
  7358. print_status,
  7359. data.get("progress"),
  7360. app_settings.base_dir,
  7361. )
  7362. # Enrich filament_grams from usage_results when archive has no 3MF data
  7363. if not archive_data.get("actual_filament_grams") and usage_results:
  7364. total_from_usage = sum(r.get("weight_used", 0) for r in usage_results)
  7365. if total_from_usage > 0:
  7366. archive_data["actual_filament_grams"] = round(total_from_usage, 1)
  7367. # Pass usage tracker results for AMS slot info in notifications
  7368. if usage_results:
  7369. archive_data["usage_results"] = usage_results
  7370. # Add finish photo URL and image bytes if available
  7371. if finish_photo_filename:
  7372. photo_url, photo_bytes = await _finish_photo_for_notification(
  7373. db, archive, archive_id, finish_photo_filename
  7374. )
  7375. if photo_url:
  7376. archive_data["finish_photo_url"] = photo_url
  7377. if photo_bytes:
  7378. archive_data["image_data"] = photo_bytes
  7379. if not await _kill_switch_notification_already_sent(kill_switch_notification_task):
  7380. await notification_service.on_print_complete(
  7381. printer_id, printer_name, print_status, data, db, archive_data=archive_data
  7382. )
  7383. else:
  7384. logger.info("[NOTIFY-BG] Skipped duplicate kill-switch provider notification")
  7385. # Post-print outcome confirmation (#1898). Runs in this
  7386. # background task so the finish photo fetched above rides
  7387. # along with the prompt.
  7388. if print_status == "completed" and archive_id:
  7389. await _dispatch_outcome_confirmation_safely(
  7390. db, printer_id, printer_name, data, archive_id, archive_data
  7391. )
  7392. # Send user-specific email notification
  7393. if archive_data:
  7394. created_by_id = archive_data.get("created_by_id")
  7395. raw_filename = data.get("subtask_name") or data.get("filename", "Unknown")
  7396. await _dispatch_user_print_email(
  7397. print_status,
  7398. created_by_id,
  7399. printer_name,
  7400. raw_filename,
  7401. db,
  7402. image_data=archive_data.get("image_data"),
  7403. finish_photo_url=archive_data.get("finish_photo_url"),
  7404. )
  7405. logger.info("[NOTIFY-BG] Completed")
  7406. except Exception as e:
  7407. logger.error("[NOTIFY-BG] Failed: %s", e, exc_info=True)
  7408. async def _background_maintenance_check():
  7409. """Check for maintenance due in background."""
  7410. if print_status != "completed":
  7411. return
  7412. try:
  7413. logger.info("[MAINT-BG] Starting maintenance check for printer %s", printer_id)
  7414. async with async_session() as db:
  7415. from backend.app.models.printer import Printer
  7416. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  7417. printer = result.scalar_one_or_none()
  7418. printer_name = printer.name if printer else f"Printer {printer_id}"
  7419. await ensure_default_types(db)
  7420. overview = await _get_printer_maintenance_internal(printer_id, db, commit=True)
  7421. items_needing_attention = [
  7422. {"name": item.maintenance_type_name, "is_due": item.is_due, "is_warning": item.is_warning}
  7423. for item in overview.maintenance_items
  7424. if item.enabled and (item.is_due or item.is_warning)
  7425. ]
  7426. if items_needing_attention:
  7427. await notification_service.on_maintenance_due(printer_id, printer_name, items_needing_attention, db)
  7428. logger.info("[MAINT-BG] Sent notification: %s items need attention", len(items_needing_attention))
  7429. # MQTT relay - publish maintenance alerts
  7430. for item in items_needing_attention:
  7431. try:
  7432. await mqtt_relay.on_maintenance_alert(
  7433. printer_id=printer_id,
  7434. printer_name=printer_name,
  7435. maintenance_type=item["name"],
  7436. current_value=0, # Not easily available here
  7437. threshold=0, # Not easily available here
  7438. )
  7439. except Exception:
  7440. pass # Don't fail if MQTT fails
  7441. else:
  7442. logger.info("[MAINT-BG] Completed (no items need attention)")
  7443. except Exception as e:
  7444. logger.warning("[MAINT-BG] Failed: %s", e)
  7445. spawn_background_task(_background_smart_plug(), name="background-smart-plug")
  7446. spawn_background_task(_background_maintenance_check(), name="background-maintenance-check")
  7447. # Notification task waits for photo capture to complete first (with timeout).
  7448. # When a timelapse was recording, photo sourcing polls the per-print
  7449. # timelapse for up to 60s (#1397) — extend the budget so the notification
  7450. # carries the correct bed-up photo instead of falling through to the
  7451. # live-cam grab. Adds ~30s of notification latency at worst on slow links.
  7452. #
  7453. # #2547: both budgets now have to cover a plate restore as well.
  7454. #
  7455. # Without timelapse, the wait is on the moment producer, which raises the
  7456. # plate before its grab — so this has to outlast that producer's own budget.
  7457. #
  7458. # With timelapse, the capture polls up to
  7459. # `_FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS` for the video and only then
  7460. # falls back to a live grab, which is the case that raises the plate. At the
  7461. # old flat 75s that fallback was guaranteed to be cut off mid-settle, so the
  7462. # restore would have moved the plate for a photo nobody waited for.
  7463. photo_wait_timeout = (
  7464. _FINISH_PHOTO_TIMELAPSE_POLL_TIMEOUT_SECONDS + _FINISH_PHOTO_PRODUCER_WAIT_SECONDS
  7465. if data.get("timelapse_was_active")
  7466. else _FINISH_PHOTO_PRODUCER_WAIT_SECONDS + 15
  7467. )
  7468. async def _photo_then_notify():
  7469. """Wait for photo capture, then send notification with photo URL."""
  7470. finish_photo = None
  7471. try:
  7472. finish_photo = await asyncio.wait_for(photo_task, timeout=photo_wait_timeout)
  7473. logger.info("[PHOTO-NOTIFY] Photo task returned: %s", finish_photo)
  7474. except TimeoutError:
  7475. logger.warning(
  7476. "[PHOTO-NOTIFY] Photo capture timed out after %ss, sending notification without photo",
  7477. photo_wait_timeout,
  7478. )
  7479. except Exception as e:
  7480. logger.warning("[PHOTO-NOTIFY] Photo task failed: %s", e)
  7481. try:
  7482. await _background_notifications(finish_photo)
  7483. except Exception as e:
  7484. logger.error("[PHOTO-NOTIFY] Notification sending failed: %s", e, exc_info=True)
  7485. spawn_background_task(_photo_then_notify(), name="photo-then-notify")
  7486. # Stitch external camera layer timelapse if session was active
  7487. print_status = data.get("status", "completed")
  7488. async def _background_layer_timelapse():
  7489. """Stitch layer timelapse and attach to archive."""
  7490. from backend.app.services.layer_timelapse import cancel_session, on_print_complete as tl_complete
  7491. try:
  7492. if print_status == "completed":
  7493. logger.info("[LAYER-TL] Stitching layer timelapse for printer %s", printer_id)
  7494. timelapse_path = await tl_complete(printer_id)
  7495. if timelapse_path and archive_id:
  7496. logger.info("[LAYER-TL] Attaching timelapse %s to archive %s", timelapse_path, archive_id)
  7497. async with async_session() as db:
  7498. service = ArchiveService(db)
  7499. timelapse_data = await asyncio.to_thread(timelapse_path.read_bytes)
  7500. await service.attach_timelapse(archive_id, timelapse_data, "layer_timelapse.mp4")
  7501. # Clean up the temp file
  7502. await asyncio.to_thread(timelapse_path.unlink, missing_ok=True)
  7503. logger.info("[LAYER-TL] Layer timelapse attached successfully")
  7504. elif timelapse_path:
  7505. # Timelapse created but no archive - just clean up
  7506. await asyncio.to_thread(timelapse_path.unlink, missing_ok=True)
  7507. else:
  7508. # Print failed or cancelled - cancel timelapse session
  7509. cancel_session(printer_id)
  7510. logger.info(
  7511. "[LAYER-TL] Cancelled layer timelapse for printer %s (status: %s)", printer_id, print_status
  7512. )
  7513. except Exception as e:
  7514. logger.warning("[LAYER-TL] Failed: %s", e)
  7515. # Try to cancel session on error
  7516. try:
  7517. cancel_session(printer_id)
  7518. except Exception:
  7519. pass # Best-effort timelapse session cancellation on error
  7520. spawn_background_task(_background_layer_timelapse(), name="background-layer-timelapse")
  7521. log_timing("All background tasks scheduled")
  7522. # Auto-scan for timelapse if recording was active during the print
  7523. if archive_id and data.get("timelapse_was_active") and data.get("status") == "completed":
  7524. logger.info("[TIMELAPSE] Timelapse was active during print, scheduling auto-scan for archive %s", archive_id)
  7525. # Schedule timelapse scan as background task with retries
  7526. # The printer needs time to encode the video after print completion
  7527. baseline = _timelapse_baselines.pop(printer_id, None)
  7528. spawn_background_task(
  7529. _scan_for_timelapse_with_retries(archive_id, baseline),
  7530. name=f"scan-timelapse-{archive_id}",
  7531. )
  7532. log_timing("Timelapse scan scheduled")
  7533. logger.info("[CALLBACK] on_print_complete finished for printer %s, archive %s", printer_id, archive_id)
  7534. # AMS sensor history recording
  7535. _ams_history_task: asyncio.Task | None = None
  7536. AMS_HISTORY_INTERVAL = 300 # Record every 5 minutes
  7537. AMS_HISTORY_RETENTION_DAYS = 30 # Keep data for 30 days
  7538. _ams_cleanup_counter = 0 # Track recordings to trigger periodic cleanup
  7539. # Track alarm cooldowns (printer_id:ams_id:type -> last_alarm_time)
  7540. _ams_alarm_cooldown: dict[str, datetime] = {}
  7541. AMS_ALARM_COOLDOWN_MINUTES = 60 # Don't send same alarm more than once per hour
  7542. # (printer_id, ams_id) already reported as sending the drop index and no
  7543. # percentage. Logged once each so a supported printer that turns out to do this
  7544. # shows up in a support bundle rather than as a user wondering where the
  7545. # humidity reading went -- see the note at the read site below (#3140).
  7546. _ams_index_only_logged: set[tuple[int, int]] = set()
  7547. def _resolve_temp_alarm_threshold(fair_threshold: float, raw_alarm_value: str | None) -> float:
  7548. """Temperature at which the AMS alarm fires, falling back to the display band.
  7549. ``ams_temp_fair`` decides when the AMS card turns amber. It used to decide
  7550. when a notification was sent as well, which is why a room above it made the
  7551. alarm fire once an hour for as long as the weather lasted -- and the only way
  7552. to stop that was to raise the display band and lose the colour that says the
  7553. unit is warm (#2905).
  7554. Unset resolves to the fair threshold, so an install that never sets one is
  7555. unchanged. Settings storage stringifies ``None`` to the literal ``"None"``,
  7556. so that arrives here as a string and is handled by the same branch as any
  7557. other unparseable value -- there is no separate sentinel to keep in sync.
  7558. A non-positive value is refused rather than honoured: zero would alarm
  7559. permanently, and it is far more likely to be a cleared field than a
  7560. deliberate choice.
  7561. """
  7562. if raw_alarm_value is None:
  7563. return fair_threshold
  7564. try:
  7565. value = float(raw_alarm_value)
  7566. except (TypeError, ValueError):
  7567. return fair_threshold
  7568. if not math.isfinite(value) or value <= 0:
  7569. return fair_threshold
  7570. return value
  7571. # Per-AMS "drying was live at" latch that suppresses the high-temperature alarm
  7572. # through a cycle and the cool-down after it (#1802). Stored in the settings
  7573. # table rather than alongside _ams_alarm_cooldown above, because a restart
  7574. # partway through a cool-down would otherwise resume alarming about heat the
  7575. # user asked for — the same internal-timestamp-row pattern as
  7576. # support.py's debug_logging_enabled_at.
  7577. AMS_DRYING_LATCH_KEY = "ams_drying_alarm_latch"
  7578. # Upper bound on that suppression. The latch normally clears as soon as the unit
  7579. # reads at or below the threshold; see utils.ams_drying for why this cap only
  7580. # matters when it never does.
  7581. AMS_DRYING_GRACE_MINUTES = 120
  7582. async def _load_ams_drying_latch(db) -> dict[str, datetime]:
  7583. """Read the persisted per-AMS drying latch, dropping entries out of window.
  7584. Anything older than the grace cap would expire on its next visit anyway, so
  7585. discarding it here costs nothing and stops rows for deleted printers from
  7586. accumulating.
  7587. Stamps ahead of now get two defences, because a box whose clock jumps
  7588. backwards (a Pi with no RTC coming up before NTP) writes them: wildly future
  7589. ones are discarded outright, and the rest are clamped to now. Without the
  7590. clamp the cap would measure from a moment that has not happened yet and hold
  7591. the alarm quiet for the skew on top of the cap. One unnecessary notification
  7592. after a clock jump is a far better failure than an alarm silently disabled
  7593. for hours.
  7594. """
  7595. from backend.app.models.settings import Settings
  7596. result = await db.execute(select(Settings).where(Settings.key == AMS_DRYING_LATCH_KEY))
  7597. setting = result.scalar_one_or_none()
  7598. if not setting or not setting.value:
  7599. return {}
  7600. try:
  7601. raw = json.loads(setting.value)
  7602. except (ValueError, TypeError):
  7603. return {} # Corrupted row → no latch, alarms behave as they did before
  7604. if not isinstance(raw, dict):
  7605. return {}
  7606. now = datetime.now(timezone.utc)
  7607. window = timedelta(minutes=AMS_DRYING_GRACE_MINUTES)
  7608. latch: dict[str, datetime] = {}
  7609. for key, value in raw.items():
  7610. try:
  7611. stamp = datetime.fromisoformat(str(value))
  7612. except (ValueError, TypeError):
  7613. continue
  7614. if stamp.tzinfo is None:
  7615. stamp = stamp.replace(tzinfo=timezone.utc)
  7616. if not (now - window <= stamp <= now + window):
  7617. continue
  7618. # Nothing may sit in the future: suppression is measured as now minus
  7619. # the stamp, so a stamp ahead of now would extend it by the skew on top
  7620. # of the cap. Clamping the survivors keeps the cap an actual cap.
  7621. latch[str(key)] = min(stamp, now)
  7622. return latch
  7623. async def _save_ams_drying_latch(db, latch: dict[str, datetime]) -> None:
  7624. """Persist the latch, writing only when it actually changed.
  7625. Adds the session change but does not commit — the caller's own commit
  7626. carries it, so the latch lands in the same transaction as the sensor rows
  7627. that produced it.
  7628. """
  7629. from backend.app.models.settings import Settings
  7630. payload = json.dumps({key: stamp.isoformat() for key, stamp in sorted(latch.items())})
  7631. result = await db.execute(select(Settings).where(Settings.key == AMS_DRYING_LATCH_KEY))
  7632. setting = result.scalar_one_or_none()
  7633. if setting is None:
  7634. # Don't create the row on installs that never dry anything.
  7635. if payload != "{}":
  7636. db.add(Settings(key=AMS_DRYING_LATCH_KEY, value=payload))
  7637. elif setting.value != payload:
  7638. setting.value = payload
  7639. def _ams_has_filament(ams_data: dict) -> bool:
  7640. """True if this AMS unit has at least one tray slot holding filament.
  7641. Bambu firmware reports loaded slots via `tray_exist_bits`, a per-AMS hex
  7642. bitmap (one bit per tray slot — bit set = spool present). Empty AMS units
  7643. still report sensor readings, but those readings are ambient and not
  7644. actionable: no filament to dry, no humidity to push down. #1619 — gate
  7645. humidity/temperature alarms on this check so empty units don't generate
  7646. hourly noise. Sensor history still records regardless so the UI charts
  7647. stay continuous.
  7648. Fallback path inspects the `tray` array's `tray_type` fields for setups
  7649. where `tray_exist_bits` is missing (some early-connection pushall shapes).
  7650. """
  7651. bits = ams_data.get("tray_exist_bits")
  7652. if isinstance(bits, str) and bits.strip():
  7653. try:
  7654. return int(bits, 16) > 0
  7655. except ValueError:
  7656. pass
  7657. trays = ams_data.get("tray")
  7658. if isinstance(trays, list):
  7659. return any(
  7660. isinstance(t, dict) and isinstance(t.get("tray_type"), str) and t["tray_type"].strip() for t in trays
  7661. )
  7662. return False
  7663. async def record_ams_history():
  7664. """Background task to record AMS humidity and temperature data."""
  7665. logger = logging.getLogger(__name__)
  7666. # Wait a short time for MQTT connections to establish on startup
  7667. await asyncio.sleep(10)
  7668. while True:
  7669. try:
  7670. from backend.app.models.ams_history import AMSSensorHistory
  7671. from backend.app.models.printer import Printer
  7672. from backend.app.models.settings import Settings
  7673. async with async_session() as db:
  7674. # Get all active printers
  7675. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  7676. printers = result.scalars().all()
  7677. # Get alarm thresholds from settings
  7678. humidity_threshold = 60.0 # Default: fair threshold
  7679. temp_fair_threshold = 35.0 # Display band default (ams_temp_fair)
  7680. result = await db.execute(select(Settings).where(Settings.key == "ams_humidity_fair"))
  7681. setting = result.scalar_one_or_none()
  7682. if setting:
  7683. try:
  7684. humidity_threshold = float(setting.value)
  7685. except (ValueError, TypeError):
  7686. pass # Keep default threshold if stored value is invalid
  7687. result = await db.execute(select(Settings).where(Settings.key == "ams_temp_fair"))
  7688. setting = result.scalar_one_or_none()
  7689. if setting:
  7690. try:
  7691. temp_fair_threshold = float(setting.value)
  7692. except (ValueError, TypeError):
  7693. pass # Keep default threshold if stored value is invalid
  7694. # The alarm gets its own threshold, seeded from the resolved fair
  7695. # value so an install that has never set one behaves exactly as
  7696. # it did before (#2905). ams_temp_fair decides when the card turns
  7697. # amber; 35 C is a reasonable place to change a colour and not a
  7698. # reasonable place to page someone. A room above it makes the
  7699. # alarm fire once an hour for as long as the weather lasts, and
  7700. # the only way to stop it was to raise the display band and lose
  7701. # the colour that says the unit is warm.
  7702. #
  7703. # An unset value is stored as the literal "None", which the except
  7704. # below swallows the same way it swallows garbage -- so the
  7705. # fallback costs nothing and needs no sentinel of its own.
  7706. result = await db.execute(select(Settings).where(Settings.key == "ams_temp_alarm"))
  7707. setting = result.scalar_one_or_none()
  7708. temp_alarm_threshold = _resolve_temp_alarm_threshold(
  7709. temp_fair_threshold, setting.value if setting else None
  7710. )
  7711. # Per-filament humidity threshold overrides (#1605) — resolved
  7712. # per-AMS below from the loaded tray types. Reuses the same
  7713. # resolver as the auto-drying scheduler so behavior stays in
  7714. # lockstep across both consumers.
  7715. from backend.app.services.print_scheduler import PrintScheduler
  7716. per_type_humidity_thresholds: dict[str, int] = {}
  7717. result = await db.execute(select(Settings).where(Settings.key == "ams_humidity_thresholds"))
  7718. setting = result.scalar_one_or_none()
  7719. if setting and setting.value:
  7720. try:
  7721. raw = json.loads(setting.value)
  7722. if isinstance(raw, dict):
  7723. for k, v in raw.items():
  7724. try:
  7725. per_type_humidity_thresholds[str(k).upper() if k != "default" else "default"] = int(
  7726. v
  7727. )
  7728. except (TypeError, ValueError):
  7729. continue
  7730. except (ValueError, TypeError):
  7731. pass # Invalid JSON → no overrides, fall through to global threshold
  7732. # Per-AMS drying latch (#1802), loaded once per pass and written
  7733. # back below only if a unit changed it.
  7734. drying_latch = await _load_ams_drying_latch(db)
  7735. drying_latch_before = dict(drying_latch)
  7736. recorded_count = 0
  7737. for printer in printers:
  7738. # Get current state from printer manager
  7739. state = printer_manager.get_status(printer.id)
  7740. if not state or not state.connected or not state.raw_data:
  7741. continue # Skip disconnected printers - don't use stale data
  7742. raw_data = state.raw_data
  7743. if "ams" not in raw_data or not isinstance(raw_data["ams"], list):
  7744. continue
  7745. # Record data for each AMS unit
  7746. for ams_data in raw_data["ams"]:
  7747. ams_id = int(ams_data.get("id", 0))
  7748. # Percentage only. The 1-5 index is inverted, so
  7749. # charting it as a percentage drew the wettest units as
  7750. # the driest (#3140); a unit that reports no percentage
  7751. # leaves a gap in the chart instead. See
  7752. # utils/ams_humidity.
  7753. humidity = ams_humidity_percent(ams_data)
  7754. # No supported printer is known to send the index
  7755. # alone -- the report came from unsupported firmware,
  7756. # and no install has been seen using the old fallback.
  7757. # "Known" is doing work there, so say so once per unit:
  7758. # the alternative is a silent blank card.
  7759. if humidity is None and ams_data.get("humidity") is not None:
  7760. unit_key = (printer.id, ams_id)
  7761. if unit_key not in _ams_index_only_logged:
  7762. _ams_index_only_logged.add(unit_key)
  7763. logger.info(
  7764. "[%s] AMS %d reports the 1-5 humidity index but no usable humidity_raw "
  7765. "percentage. The index is inverted and is not shown as a percentage "
  7766. "(#3140), so this unit has no humidity reading, chart or alarm. "
  7767. "Please report this with the printer and AMS firmware versions.",
  7768. printer.name,
  7769. ams_id,
  7770. )
  7771. # Get temperature
  7772. temperature = None
  7773. temp_str = ams_data.get("temp")
  7774. if temp_str is not None:
  7775. try:
  7776. temperature = float(temp_str)
  7777. except (ValueError, TypeError):
  7778. pass # Skip unparseable temperature value
  7779. # Skip if no data
  7780. if humidity is None and temperature is None:
  7781. continue
  7782. # Record the data point
  7783. history = AMSSensorHistory(
  7784. printer_id=printer.id,
  7785. ams_id=ams_id,
  7786. humidity=humidity,
  7787. # Both columns hold the same reading now that the
  7788. # index can no longer reach ``humidity``. Writing it
  7789. # through the same value also stops a genuine 0%
  7790. # from being stored as NULL, which the old truthiness
  7791. # test did.
  7792. humidity_raw=humidity,
  7793. temperature=temperature,
  7794. )
  7795. db.add(history)
  7796. recorded_count += 1
  7797. # Generate AMS label and determine if it's AMS-HT (A, B, C, D or HT-A for AMS-Lite/Hub)
  7798. is_ams_ht = ams_id >= 128
  7799. if is_ams_ht:
  7800. ams_label = f"HT-{chr(65 + (ams_id - 128))}"
  7801. else:
  7802. ams_label = f"AMS-{chr(65 + ams_id)}"
  7803. # Skip alarm dispatch for empty AMS units — humidity /
  7804. # temperature readings are ambient with no filament to
  7805. # protect, and the hourly notification just becomes
  7806. # noise. Sensor history was already recorded above so
  7807. # the UI charts stay continuous (#1619). Per-AMS check
  7808. # so a multi-AMS setup with one loaded + one empty
  7809. # still alarms on the loaded unit.
  7810. if not _ams_has_filament(ams_data):
  7811. continue
  7812. # Resolve per-filament humidity threshold for this AMS
  7813. # unit (#1605). Falls back to the global ams_humidity_fair
  7814. # when no per-type overrides are configured.
  7815. trays = ams_data.get("tray", []) or []
  7816. effective_humidity_threshold = float(
  7817. PrintScheduler.resolve_humidity_threshold(
  7818. trays, per_type_humidity_thresholds, int(humidity_threshold)
  7819. )
  7820. )
  7821. # Check humidity alarm (only if above threshold)
  7822. if humidity is not None and humidity > effective_humidity_threshold:
  7823. cooldown_key = f"{printer.id}:{ams_id}:humidity"
  7824. last_alarm = _ams_alarm_cooldown.get(cooldown_key)
  7825. now = datetime.now(timezone.utc)
  7826. if (
  7827. last_alarm is None
  7828. or (now - last_alarm).total_seconds() >= AMS_ALARM_COOLDOWN_MINUTES * 60
  7829. ):
  7830. _ams_alarm_cooldown[cooldown_key] = now
  7831. logger.info(
  7832. f"Sending humidity alarm for {printer.name} {ams_label}: {humidity}% > {effective_humidity_threshold}%"
  7833. )
  7834. try:
  7835. # Call different notification method based on AMS type
  7836. if is_ams_ht:
  7837. await notification_service.on_ams_ht_humidity_high(
  7838. printer.id,
  7839. printer.name,
  7840. ams_label,
  7841. humidity,
  7842. effective_humidity_threshold,
  7843. db,
  7844. )
  7845. else:
  7846. await notification_service.on_ams_humidity_high(
  7847. printer.id,
  7848. printer.name,
  7849. ams_label,
  7850. humidity,
  7851. effective_humidity_threshold,
  7852. db,
  7853. )
  7854. except Exception as e:
  7855. logger.warning("Failed to send humidity alarm: %s", e)
  7856. # A drying cycle heats the unit far past ams_temp_fair on
  7857. # purpose — 45 C for PLA, 65 C for PETG, 85 C on an
  7858. # AMS-HT, against a 35 C default — so the alarm fired
  7859. # once an hour for the whole cycle and kept firing while
  7860. # the unit cooled back down (#1802). Latch on the
  7861. # firmware's own drying state and hold until the reading
  7862. # returns to normal. Humidity is deliberately left alone:
  7863. # it falls during drying, which is the whole point.
  7864. latch_key = f"{printer.id}:{ams_id}"
  7865. # The latch releases at `threshold`, so it takes the alarm
  7866. # number too. Handing it the display band would strand the
  7867. # latch on any unit that settles back above it -- a room
  7868. # where the AMS rests at 37.7 C never returns under a 35 C
  7869. # band, so the latch could only expire on the grace cap
  7870. # rather than releasing when the unit had actually cooled.
  7871. suppress_temp_alarm, new_latch = temperature_alarm_suppressed(
  7872. drying_active=is_drying_active(ams_data),
  7873. temperature=temperature,
  7874. threshold=temp_alarm_threshold,
  7875. latched_at=drying_latch.get(latch_key),
  7876. now=datetime.now(timezone.utc),
  7877. grace_minutes=AMS_DRYING_GRACE_MINUTES,
  7878. )
  7879. if new_latch is None:
  7880. drying_latch.pop(latch_key, None)
  7881. else:
  7882. drying_latch[latch_key] = new_latch
  7883. # Check temperature alarm (only if above threshold)
  7884. if temperature is not None and temperature > temp_alarm_threshold and not suppress_temp_alarm:
  7885. cooldown_key = f"{printer.id}:{ams_id}:temperature"
  7886. last_alarm = _ams_alarm_cooldown.get(cooldown_key)
  7887. now = datetime.now(timezone.utc)
  7888. if (
  7889. last_alarm is None
  7890. or (now - last_alarm).total_seconds() >= AMS_ALARM_COOLDOWN_MINUTES * 60
  7891. ):
  7892. _ams_alarm_cooldown[cooldown_key] = now
  7893. logger.info(
  7894. f"Sending temperature alarm for {printer.name} {ams_label}: "
  7895. f"{temperature}°C > {temp_alarm_threshold}°C"
  7896. )
  7897. try:
  7898. # Call different notification method based on AMS type
  7899. if is_ams_ht:
  7900. # The reported threshold has to be the one
  7901. # that fired, or the message says "> 35 °C"
  7902. # while firing at 45.
  7903. await notification_service.on_ams_ht_temperature_high(
  7904. printer.id, printer.name, ams_label, temperature, temp_alarm_threshold, db
  7905. )
  7906. else:
  7907. await notification_service.on_ams_temperature_high(
  7908. printer.id, printer.name, ams_label, temperature, temp_alarm_threshold, db
  7909. )
  7910. except Exception as e:
  7911. logger.warning("Failed to send temperature alarm: %s", e)
  7912. if drying_latch != drying_latch_before:
  7913. await _save_ams_drying_latch(db, drying_latch)
  7914. await db.commit()
  7915. if recorded_count > 0:
  7916. logger.info("Recorded %s AMS sensor history entries", recorded_count)
  7917. # Periodic cleanup of old data (every ~288 recordings = ~24 hours at 5min interval)
  7918. global _ams_cleanup_counter
  7919. _ams_cleanup_counter += 1
  7920. if _ams_cleanup_counter >= 288:
  7921. _ams_cleanup_counter = 0
  7922. # Get retention days from settings
  7923. from backend.app.models.settings import Settings
  7924. result = await db.execute(select(Settings).where(Settings.key == "ams_history_retention_days"))
  7925. setting = result.scalar_one_or_none()
  7926. retention_days = int(setting.value) if setting else AMS_HISTORY_RETENTION_DAYS
  7927. cutoff = utcnow_naive() - timedelta(days=retention_days)
  7928. result = await db.execute(delete(AMSSensorHistory).where(AMSSensorHistory.recorded_at < cutoff))
  7929. await db.commit()
  7930. if result.rowcount > 0:
  7931. logger.info(
  7932. f"Cleaned up {result.rowcount} old AMS sensor history entries (older than {retention_days} days)"
  7933. )
  7934. # Wait until next recording interval
  7935. await asyncio.sleep(AMS_HISTORY_INTERVAL)
  7936. except asyncio.CancelledError:
  7937. break
  7938. except Exception as e:
  7939. logger.warning("AMS history recording failed: %s", e)
  7940. await asyncio.sleep(60) # Wait a bit before retrying
  7941. def start_ams_history_recording():
  7942. """Start the AMS history recording background task."""
  7943. global _ams_history_task
  7944. if _ams_history_task is None:
  7945. _ams_history_task = asyncio.create_task(record_ams_history())
  7946. logging.getLogger(__name__).info("AMS history recording started")
  7947. def stop_ams_history_recording():
  7948. """Stop the AMS history recording background task."""
  7949. global _ams_history_task
  7950. if _ams_history_task:
  7951. _ams_history_task.cancel()
  7952. _ams_history_task = None
  7953. logging.getLogger(__name__).info("AMS history recording stopped")
  7954. # Printer sensor history recording (nozzle / bed / chamber)
  7955. _printer_sensor_history_task: asyncio.Task | None = None
  7956. PRINTER_SENSOR_HISTORY_INTERVAL = 60 # Record every minute — heaters move faster than AMS humidity
  7957. PRINTER_SENSOR_HISTORY_RETENTION_DAYS = 30
  7958. _printer_sensor_cleanup_counter = 0
  7959. # Sensor kinds tracked in state.temperatures — these are the normalised keys the
  7960. # MQTT parser writes, so we don't need to handle per-model field aliases here
  7961. # (nozzle_temper / left_nozzle_temper / right_nozzle_temper / chamber_temper
  7962. # are all collapsed by services/bambu_mqtt.py before they reach this loop).
  7963. _SENSOR_KINDS = ("nozzle", "nozzle_2", "bed", "chamber")
  7964. _SENSOR_TARGET_KEYS = {
  7965. "nozzle": "nozzle_target",
  7966. "nozzle_2": "nozzle_2_target",
  7967. "bed": "bed_target",
  7968. "chamber": "chamber_target",
  7969. }
  7970. async def record_printer_sensor_history():
  7971. """Background task to record nozzle / bed / chamber readings.
  7972. Pulls from `state.temperatures` (already normalised across all printer
  7973. models by the MQTT parser) rather than re-parsing raw_data, so we get
  7974. free coverage of dual-nozzle H2D, sensor-only X1C chamber, etc.
  7975. """
  7976. logger = logging.getLogger(__name__)
  7977. await asyncio.sleep(10)
  7978. while True:
  7979. try:
  7980. from backend.app.models.printer import Printer
  7981. from backend.app.models.printer_sensor_history import PrinterSensorHistory
  7982. from backend.app.models.settings import Settings
  7983. async with async_session() as db:
  7984. result = await db.execute(select(Printer).where(Printer.is_active.is_(True)))
  7985. printers = result.scalars().all()
  7986. recorded_count = 0
  7987. for printer in printers:
  7988. state = printer_manager.get_status(printer.id)
  7989. if not state or not state.connected:
  7990. continue
  7991. temps = getattr(state, "temperatures", None) or {}
  7992. if not isinstance(temps, dict):
  7993. continue
  7994. for kind in _SENSOR_KINDS:
  7995. if kind not in temps:
  7996. continue
  7997. try:
  7998. value = float(temps[kind])
  7999. except (ValueError, TypeError):
  8000. continue
  8001. target_raw = temps.get(_SENSOR_TARGET_KEYS[kind])
  8002. target_val: float | None = None
  8003. if target_raw is not None:
  8004. try:
  8005. target_val = float(target_raw)
  8006. except (ValueError, TypeError):
  8007. target_val = None
  8008. db.add(
  8009. PrinterSensorHistory(
  8010. printer_id=printer.id,
  8011. sensor_kind=kind,
  8012. value=value,
  8013. target=target_val,
  8014. )
  8015. )
  8016. recorded_count += 1
  8017. await db.commit()
  8018. if recorded_count > 0:
  8019. logger.debug("Recorded %s printer sensor history entries", recorded_count)
  8020. # Periodic cleanup — once every ~24h at this interval.
  8021. global _printer_sensor_cleanup_counter
  8022. _printer_sensor_cleanup_counter += 1
  8023. cleanup_every = max(1, (24 * 60 * 60) // PRINTER_SENSOR_HISTORY_INTERVAL)
  8024. if _printer_sensor_cleanup_counter >= cleanup_every:
  8025. _printer_sensor_cleanup_counter = 0
  8026. result = await db.execute(
  8027. select(Settings).where(Settings.key == "printer_sensor_history_retention_days")
  8028. )
  8029. setting = result.scalar_one_or_none()
  8030. retention_days = int(setting.value) if setting else PRINTER_SENSOR_HISTORY_RETENTION_DAYS
  8031. cutoff = utcnow_naive() - timedelta(days=retention_days)
  8032. cleanup = await db.execute(
  8033. delete(PrinterSensorHistory).where(PrinterSensorHistory.recorded_at < cutoff)
  8034. )
  8035. await db.commit()
  8036. if cleanup.rowcount > 0:
  8037. logger.info(
  8038. "Cleaned up %s old printer sensor history entries (older than %s days)",
  8039. cleanup.rowcount,
  8040. retention_days,
  8041. )
  8042. await asyncio.sleep(PRINTER_SENSOR_HISTORY_INTERVAL)
  8043. except asyncio.CancelledError:
  8044. break
  8045. except Exception as e:
  8046. logger.warning("Printer sensor history recording failed: %s", e)
  8047. await asyncio.sleep(60)
  8048. def start_printer_sensor_history_recording():
  8049. global _printer_sensor_history_task
  8050. if _printer_sensor_history_task is None:
  8051. _printer_sensor_history_task = asyncio.create_task(record_printer_sensor_history())
  8052. logging.getLogger(__name__).info("Printer sensor history recording started")
  8053. def stop_printer_sensor_history_recording():
  8054. global _printer_sensor_history_task
  8055. if _printer_sensor_history_task:
  8056. _printer_sensor_history_task.cancel()
  8057. _printer_sensor_history_task = None
  8058. logging.getLogger(__name__).info("Printer sensor history recording stopped")
  8059. # Printer runtime tracking
  8060. _runtime_tracking_task: asyncio.Task | None = None
  8061. RUNTIME_TRACKING_INTERVAL = 30 # Update every 30 seconds
  8062. async def track_printer_runtime():
  8063. """Background task to track printer active runtime (RUNNING state only).
  8064. PAUSE is intentionally excluded — the runtime counter feeds hours-based
  8065. maintenance intervals (rod lubrication, belt checks, nozzle cleaning)
  8066. which track mechanical wear. Pause time has no motion and no wear, so
  8067. counting it inflates maintenance warnings (#1521).
  8068. """
  8069. logger = logging.getLogger(__name__)
  8070. # Wait for MQTT connections to establish on startup
  8071. await asyncio.sleep(15)
  8072. while True:
  8073. try:
  8074. from backend.app.models.printer import Printer
  8075. # Fetch printer IDs in a short-lived read-only session
  8076. async with async_session() as db:
  8077. result = await db.execute(
  8078. select(Printer.id, Printer.name, Printer.runtime_seconds, Printer.last_runtime_update).where(
  8079. Printer.is_active.is_(True)
  8080. )
  8081. )
  8082. printer_rows = result.all()
  8083. now = datetime.now(timezone.utc)
  8084. updated_count = 0
  8085. # Update each printer in its own short session to minimise write-lock
  8086. # hold time and avoid blocking critical commits like queue status
  8087. # updates (#897).
  8088. for pid, pname, runtime_secs, last_update in printer_rows:
  8089. state = printer_manager.get_status(pid)
  8090. if not state:
  8091. logger.debug("[%s] Runtime tracking: no state available", pname)
  8092. continue
  8093. if not state.connected:
  8094. logger.debug("[%s] Runtime tracking: not connected", pname)
  8095. continue
  8096. needs_commit = False
  8097. new_runtime = runtime_secs
  8098. new_last_update = last_update
  8099. if state.state == "RUNNING":
  8100. if last_update:
  8101. lu = last_update if last_update.tzinfo else last_update.replace(tzinfo=timezone.utc)
  8102. elapsed = (now - lu).total_seconds()
  8103. if elapsed > 0:
  8104. new_runtime = runtime_secs + int(elapsed)
  8105. updated_count += 1
  8106. needs_commit = True
  8107. logger.debug(
  8108. f"[{pname}] Runtime tracking: added {int(elapsed)}s, "
  8109. f"total={new_runtime}s ({new_runtime / 3600:.2f}h)"
  8110. )
  8111. else:
  8112. needs_commit = True
  8113. logger.debug("[%s] Runtime tracking: first active detection", pname)
  8114. new_last_update = now
  8115. else:
  8116. if last_update is not None:
  8117. logger.debug(f"[{pname}] Runtime tracking: state={state.state}, clearing last_runtime_update")
  8118. new_last_update = None
  8119. needs_commit = True
  8120. if needs_commit:
  8121. try:
  8122. async with async_session() as db:
  8123. result = await db.execute(select(Printer).where(Printer.id == pid))
  8124. printer = result.scalar_one_or_none()
  8125. if printer:
  8126. printer.runtime_seconds = new_runtime
  8127. printer.last_runtime_update = new_last_update
  8128. await db.commit()
  8129. except Exception as e:
  8130. logger.warning("[%s] Runtime tracking commit failed: %s", pname, e)
  8131. if updated_count > 0:
  8132. logger.debug("Updated runtime for %s printer(s)", updated_count)
  8133. except asyncio.CancelledError:
  8134. logger.info("Runtime tracking cancelled")
  8135. break
  8136. except Exception as e:
  8137. logger.warning("Runtime tracking failed: %s", e)
  8138. await asyncio.sleep(RUNTIME_TRACKING_INTERVAL)
  8139. def start_runtime_tracking():
  8140. """Start the printer runtime tracking background task."""
  8141. global _runtime_tracking_task
  8142. if _runtime_tracking_task is None:
  8143. _runtime_tracking_task = asyncio.create_task(track_printer_runtime())
  8144. logging.getLogger(__name__).info("Printer runtime tracking started")
  8145. def stop_runtime_tracking():
  8146. """Stop the printer runtime tracking background task."""
  8147. global _runtime_tracking_task
  8148. if _runtime_tracking_task:
  8149. _runtime_tracking_task.cancel()
  8150. _runtime_tracking_task = None
  8151. logging.getLogger(__name__).info("Printer runtime tracking stopped")
  8152. # SpoolBuddy device watchdog
  8153. _spoolbuddy_watchdog_task: asyncio.Task | None = None
  8154. SPOOLBUDDY_WATCHDOG_INTERVAL = 15
  8155. async def _spoolbuddy_watchdog_loop():
  8156. """Periodic check for SpoolBuddy devices that have gone offline."""
  8157. from backend.app.api.routes.spoolbuddy import spoolbuddy_watchdog
  8158. while True:
  8159. try:
  8160. await spoolbuddy_watchdog()
  8161. except asyncio.CancelledError:
  8162. break
  8163. except Exception as e:
  8164. logging.getLogger(__name__).warning("SpoolBuddy watchdog failed: %s", e)
  8165. await asyncio.sleep(SPOOLBUDDY_WATCHDOG_INTERVAL)
  8166. def start_spoolbuddy_watchdog():
  8167. global _spoolbuddy_watchdog_task
  8168. if _spoolbuddy_watchdog_task is None:
  8169. _spoolbuddy_watchdog_task = asyncio.create_task(_spoolbuddy_watchdog_loop())
  8170. logging.getLogger(__name__).info("SpoolBuddy watchdog started")
  8171. def stop_spoolbuddy_watchdog():
  8172. global _spoolbuddy_watchdog_task
  8173. if _spoolbuddy_watchdog_task:
  8174. _spoolbuddy_watchdog_task.cancel()
  8175. _spoolbuddy_watchdog_task = None
  8176. logging.getLogger(__name__).info("SpoolBuddy watchdog stopped")
  8177. # Dead-MQTT-session recovery
  8178. #
  8179. # check_staleness() covers the "connected but silent" half-broken session. It
  8180. # does nothing once ``state.connected`` is False, and paho's own auto-reconnect
  8181. # is the only thing left watching at that point. When paho stops making
  8182. # progress there is no backstop at all: the #2732 bundle has a P1S drop on a
  8183. # keep-alive timeout at 02:19 and not reconnect until 11:24 — nine hours
  8184. # offline with the UI open the whole time, recovered only when something
  8185. # happened to nudge it.
  8186. #
  8187. # This loop is that backstop. It only touches printers that had a working
  8188. # session and lost it, and only when the MQTT port still answers — a printer
  8189. # that is simply switched off is left to paho, since rebuilding a client
  8190. # against an unreachable host achieves nothing and would fill the log every
  8191. # night.
  8192. _connection_watchdog_task: asyncio.Task | None = None
  8193. CONNECTION_WATCHDOG_INTERVAL = 60
  8194. # How long a printer must have been silent before we stop trusting paho.
  8195. # Comfortably above STALE_TIMEOUT (60 s) and the max reconnect backoff (30 s),
  8196. # so a session that is recovering on its own is never interrupted.
  8197. CONNECTION_WATCHDOG_OFFLINE_GRACE = 300
  8198. # Per-printer floor between rebuild attempts.
  8199. CONNECTION_WATCHDOG_RETRY_INTERVAL = 300
  8200. _connection_watchdog_last_attempt: dict[int, float] = {}
  8201. async def _recover_dead_printer_sessions() -> int:
  8202. """Rebuild MQTT clients that have been offline too long to still be trying.
  8203. Returns the number of printers a rebuild was attempted for (for tests and
  8204. for the caller's logging). Never raises: one unreachable printer must not
  8205. stop the sweep for the rest of the farm.
  8206. """
  8207. logger = logging.getLogger(__name__)
  8208. from backend.app.services.printer_diagnostic import PORT_MQTT, check_port
  8209. now = time.monotonic()
  8210. recovered = 0
  8211. for printer_id, client in list(printer_manager._clients.items()):
  8212. try:
  8213. if client.state.connected:
  8214. _connection_watchdog_last_attempt.pop(printer_id, None)
  8215. continue
  8216. # Time since the last inbound message is the age of the last known
  8217. # good session — no extra bookkeeping needed, and it is the same
  8218. # clock is_stale() reads. 0 means this client has never had one:
  8219. # that is the initial-connect path, where paho retrying is the
  8220. # correct and only behaviour, so leave it be.
  8221. last_msg = client._last_message_time
  8222. if not last_msg:
  8223. continue
  8224. offline_for = time.time() - last_msg
  8225. if offline_for < CONNECTION_WATCHDOG_OFFLINE_GRACE:
  8226. continue
  8227. last_attempt = _connection_watchdog_last_attempt.get(printer_id)
  8228. if last_attempt is not None and now - last_attempt < CONNECTION_WATCHDOG_RETRY_INTERVAL:
  8229. continue
  8230. if not await check_port(client.ip_address, PORT_MQTT):
  8231. # Switched off, unplugged, or off the network. Paho's retry is
  8232. # the right handler; say so at debug level and move on.
  8233. logger.debug(
  8234. "[#2732] Printer %s offline for %.0fs and its MQTT port is not answering "
  8235. "— leaving the reconnect to paho",
  8236. printer_id,
  8237. offline_for,
  8238. )
  8239. _connection_watchdog_last_attempt[printer_id] = now
  8240. continue
  8241. _connection_watchdog_last_attempt[printer_id] = now
  8242. recovered += 1
  8243. logger.warning(
  8244. "[#2732] Printer %s has been offline for %.0fs but answers on MQTT port %d — "
  8245. "rebuilding the client with a fresh session (last connect error: %s)",
  8246. printer_id,
  8247. offline_for,
  8248. PORT_MQTT,
  8249. client.last_connect_error or "none recorded",
  8250. )
  8251. # Async context, so this takes the hard-reset path: fresh client_id,
  8252. # paho's QoS 1 queue dropped. That matters — a project_file left
  8253. # unacked on the dead session would otherwise replay into the new
  8254. # one and trip 0500_4003 on the printer (#1136).
  8255. client.force_reconnect_stale_session(f"offline for {offline_for:.0f}s, port still answering")
  8256. except Exception as e:
  8257. logger.warning("[#2732] Connection watchdog failed for printer %s: %s", printer_id, e)
  8258. return recovered
  8259. async def _connection_watchdog_loop():
  8260. logger = logging.getLogger(__name__)
  8261. # Let the initial connects settle before judging anyone offline.
  8262. await asyncio.sleep(CONNECTION_WATCHDOG_OFFLINE_GRACE)
  8263. while True:
  8264. try:
  8265. await _recover_dead_printer_sessions()
  8266. except asyncio.CancelledError:
  8267. break
  8268. except Exception as e:
  8269. logger.warning("Connection watchdog sweep failed: %s", e)
  8270. await asyncio.sleep(CONNECTION_WATCHDOG_INTERVAL)
  8271. def start_connection_watchdog():
  8272. global _connection_watchdog_task
  8273. if _connection_watchdog_task is None:
  8274. _connection_watchdog_task = asyncio.create_task(_connection_watchdog_loop())
  8275. logging.getLogger(__name__).info("Printer connection watchdog started")
  8276. def stop_connection_watchdog():
  8277. global _connection_watchdog_task
  8278. if _connection_watchdog_task:
  8279. _connection_watchdog_task.cancel()
  8280. _connection_watchdog_task = None
  8281. _connection_watchdog_last_attempt.clear()
  8282. logging.getLogger(__name__).info("Printer connection watchdog stopped")
  8283. # Camera stream orphan cleanup
  8284. _camera_cleanup_task: asyncio.Task | None = None
  8285. CAMERA_CLEANUP_INTERVAL = 60
  8286. async def _camera_cleanup_loop():
  8287. """Periodically clean up orphaned ffmpeg processes."""
  8288. from backend.app.api.routes.camera import cleanup_orphaned_streams
  8289. while True:
  8290. try:
  8291. await cleanup_orphaned_streams()
  8292. except asyncio.CancelledError:
  8293. break
  8294. except Exception as e:
  8295. logging.getLogger(__name__).warning("Camera stream cleanup failed: %s", e)
  8296. await asyncio.sleep(CAMERA_CLEANUP_INTERVAL)
  8297. def start_camera_cleanup():
  8298. global _camera_cleanup_task
  8299. if _camera_cleanup_task is None:
  8300. _camera_cleanup_task = asyncio.create_task(_camera_cleanup_loop())
  8301. logging.getLogger(__name__).info("Camera stream cleanup started")
  8302. def stop_camera_cleanup():
  8303. global _camera_cleanup_task
  8304. if _camera_cleanup_task:
  8305. _camera_cleanup_task.cancel()
  8306. _camera_cleanup_task = None
  8307. logging.getLogger(__name__).info("Camera stream cleanup stopped")
  8308. # ---------------------------------------------------------------------------
  8309. # Expected-print TTL eviction
  8310. # ---------------------------------------------------------------------------
  8311. def _evict_stale_expected_prints() -> None:
  8312. """Remove entries from _expected_prints / _expected_print_creators that are
  8313. older than _EXPECTED_PRINT_TTL_SECONDS.
  8314. This prevents unbounded growth when a print is registered (via
  8315. register_expected_print) but on_print_start never fires — e.g. because the
  8316. printer disconnects, the app restarts, or the print is started directly from
  8317. the printer panel without going through the queue.
  8318. """
  8319. # Use monotonic time so the TTL is unaffected by system clock adjustments
  8320. # (e.g. NTP sync, DST changes).
  8321. cutoff = time.monotonic() - _EXPECTED_PRINT_TTL_SECONDS
  8322. stale_keys = [k for k, t in _expected_print_registered_at.items() if t < cutoff]
  8323. if not stale_keys:
  8324. return
  8325. evicted_archive_ids: set[int] = set()
  8326. for key in stale_keys:
  8327. archive_id = _expected_prints.pop(key, None)
  8328. if archive_id is not None:
  8329. evicted_archive_ids.add(archive_id)
  8330. _expected_print_creators.pop(key, None)
  8331. _expected_print_registered_at.pop(key, None)
  8332. # Also clean up _print_ams_mappings and _print_plate_ids for archive_ids
  8333. # that have no remaining live keys in _expected_prints (all variants
  8334. # were just evicted).
  8335. live_archive_ids = set(_expected_prints.values())
  8336. for archive_id in evicted_archive_ids:
  8337. if archive_id not in live_archive_ids:
  8338. _print_ams_mappings.pop(archive_id, None)
  8339. _print_cost_center_ids.pop(archive_id, None)
  8340. _print_plate_ids.pop(archive_id, None)
  8341. logging.getLogger(__name__).info(
  8342. "Evicted %d stale expected-print entries (TTL=%ds)", len(stale_keys), _EXPECTED_PRINT_TTL_SECONDS
  8343. )
  8344. async def _expected_prints_cleanup_loop() -> None:
  8345. """Background task: periodically evict stale expected-print entries."""
  8346. while True:
  8347. try:
  8348. _evict_stale_expected_prints()
  8349. except asyncio.CancelledError:
  8350. raise
  8351. except Exception as e:
  8352. logging.getLogger(__name__).warning("Expected prints cleanup failed: %s", e)
  8353. await asyncio.sleep(_EXPECTED_PRINT_CLEANUP_INTERVAL)
  8354. def start_expected_prints_cleanup() -> None:
  8355. global _expected_prints_cleanup_task
  8356. if _expected_prints_cleanup_task is None:
  8357. _expected_prints_cleanup_task = asyncio.create_task(_expected_prints_cleanup_loop())
  8358. logging.getLogger(__name__).info("Expected prints cleanup started")
  8359. def stop_expected_prints_cleanup() -> None:
  8360. global _expected_prints_cleanup_task
  8361. if _expected_prints_cleanup_task:
  8362. _expected_prints_cleanup_task.cancel()
  8363. _expected_prints_cleanup_task = None
  8364. logging.getLogger(__name__).info("Expected prints cleanup stopped")
  8365. # ---------------------------------------------------------------------------
  8366. # L-2: Periodic auth-token cleanup (stale TOTP + expired revoked JTIs)
  8367. # ---------------------------------------------------------------------------
  8368. _auth_cleanup_task: asyncio.Task | None = None
  8369. _AUTH_CLEANUP_INTERVAL = 3600 # seconds (hourly)
  8370. async def _run_auth_cleanup() -> None:
  8371. """Single cleanup pass: remove stale TOTP records, expired revoked JTIs, and old rate-limit events."""
  8372. from backend.app.core.database import async_session
  8373. from backend.app.models.auth_ephemeral import AuthEphemeralToken, AuthRateLimitEvent
  8374. from backend.app.models.user_totp import UserTOTP
  8375. now = datetime.now(timezone.utc)
  8376. # Remove unconfirmed (is_enabled=False) TOTP records older than 1 hour.
  8377. try:
  8378. async with async_session() as db:
  8379. stale_cutoff = now - timedelta(hours=1)
  8380. result = await db.execute(
  8381. select(UserTOTP).where(
  8382. UserTOTP.is_enabled.is_(False),
  8383. UserTOTP.created_at < stale_cutoff,
  8384. )
  8385. )
  8386. stale_records = result.scalars().all()
  8387. if stale_records:
  8388. for rec in stale_records:
  8389. await db.delete(rec)
  8390. await db.commit()
  8391. logging.info("Auth cleanup: removed %d stale unconfirmed TOTP record(s)", len(stale_records))
  8392. except Exception as e:
  8393. logging.warning("Auth cleanup: failed to purge stale TOTP records: %s", e)
  8394. # Remove expired revoked-JTI entries (they are no longer needed once the
  8395. # original token's exp has passed — the token would be rejected by JWT
  8396. # signature verification regardless).
  8397. try:
  8398. async with async_session() as db:
  8399. await db.execute(
  8400. delete(AuthEphemeralToken).where(
  8401. AuthEphemeralToken.token_type == "revoked_jti",
  8402. AuthEphemeralToken.expires_at < now,
  8403. )
  8404. )
  8405. await db.commit()
  8406. except Exception as e:
  8407. logging.warning("Auth cleanup: failed to purge expired revoked JTIs: %s", e)
  8408. # L-R6-B: Purge AuthRateLimitEvent rows older than the lockout window (15 min).
  8409. # Events outside this window can never affect rate-limit decisions — they only
  8410. # consume DB space. Use the same window constant as the rate limiter so the
  8411. # two are always in sync.
  8412. try:
  8413. from backend.app.api.routes.mfa import LOCKOUT_WINDOW
  8414. async with async_session() as db:
  8415. await db.execute(
  8416. delete(AuthRateLimitEvent).where(
  8417. AuthRateLimitEvent.occurred_at < now - LOCKOUT_WINDOW,
  8418. )
  8419. )
  8420. await db.commit()
  8421. except Exception as e:
  8422. logging.warning("Auth cleanup: failed to purge stale rate-limit events: %s", e)
  8423. async def _auth_cleanup_loop() -> None:
  8424. """Periodic background task: run auth cleanup every hour."""
  8425. while True:
  8426. try:
  8427. await _run_auth_cleanup()
  8428. except asyncio.CancelledError:
  8429. break
  8430. except Exception as e:
  8431. logging.warning("Auth cleanup loop error: %s", e)
  8432. await asyncio.sleep(_AUTH_CLEANUP_INTERVAL)
  8433. def start_auth_cleanup() -> None:
  8434. global _auth_cleanup_task
  8435. if _auth_cleanup_task is None:
  8436. _auth_cleanup_task = asyncio.create_task(_auth_cleanup_loop())
  8437. logging.getLogger(__name__).info("Auth periodic cleanup started")
  8438. def stop_auth_cleanup() -> None:
  8439. global _auth_cleanup_task
  8440. if _auth_cleanup_task:
  8441. _auth_cleanup_task.cancel()
  8442. _auth_cleanup_task = None
  8443. logging.getLogger(__name__).info("Auth periodic cleanup stopped")
  8444. @asynccontextmanager
  8445. async def lifespan(app: FastAPI):
  8446. # Startup
  8447. # Install Windows-only asyncio Proactor cleanup-RST filter (#1113) before
  8448. # anything else can spawn tasks that might trip it.
  8449. from backend.app.core.asyncio_handlers import install_proactor_reset_filter, warn_if_running_on_uvloop
  8450. install_proactor_reset_filter()
  8451. # Before init_db, so the warning is near the top of the log rather than
  8452. # below a migration run. See warn_if_running_on_uvloop for what is at stake.
  8453. warn_if_running_on_uvloop()
  8454. await init_db()
  8455. # Browser download tokens expire after five minutes. Remove abandoned
  8456. # prepared ZIPs at startup as well as before each new preparation so a
  8457. # quiet appliance cannot retain an unusable bundle indefinitely.
  8458. try:
  8459. from backend.app.services.printer_media import prune_stale_printer_file_bundles
  8460. await prune_stale_printer_file_bundles()
  8461. except Exception as exc:
  8462. logging.warning("Failed to prune stale printer download bundles: %s", exc)
  8463. # After migrations, so the is_env_managed column exists. Never raises --
  8464. # a bad BAMBUDDY_OIDC_* value is logged and skipped rather than blocking
  8465. # startup (see apply_env_oidc_provider).
  8466. from backend.app.core.oidc_env import apply_env_oidc_provider
  8467. async with async_session() as oidc_db:
  8468. await apply_env_oidc_provider(oidc_db)
  8469. # Close out batches that finished before `completed` was a reachable status
  8470. # (#342). Without this the Batches tab opens on every batch created since
  8471. # the feature shipped, all still marked active. Never blocks startup.
  8472. try:
  8473. from backend.app.services.print_batch import backfill_batch_statuses
  8474. async with async_session() as batch_db:
  8475. await backfill_batch_statuses(batch_db)
  8476. except Exception as exc:
  8477. logging.warning("[BATCH] Startup status backfill failed: %s", exc)
  8478. # Register an app-scoped httpx client for Bambu Cloud services so
  8479. # per-request BambuCloudService instances reuse the same connection pool
  8480. # (important for routes like /cloud/filament-info that chain many
  8481. # get_setting_detail calls). The shared client stores no region/token
  8482. # state, so the per-request ownership pattern that fixed the region-bleed
  8483. # bug is preserved.
  8484. import httpx as _httpx
  8485. from backend.app.services.bambu_cloud import set_shared_http_client
  8486. from backend.app.services.model_providers.makerworld.service import (
  8487. set_shared_http_client as set_shared_makerworld_http_client,
  8488. )
  8489. from backend.app.services.orca_cloud import (
  8490. set_shared_http_client as set_shared_orca_http_client,
  8491. )
  8492. _shared_cloud_http_client = _httpx.AsyncClient(timeout=30.0)
  8493. set_shared_http_client(_shared_cloud_http_client)
  8494. # Reuse the same connection pool for MakerWorld — different host, same
  8495. # keep-alive pool saves a TLS handshake per request.
  8496. set_shared_makerworld_http_client(_shared_cloud_http_client)
  8497. # Same for Orca Cloud — without this the per-request OrcaCloudService()
  8498. # each spun up (and never closed) its own client, leaking sockets.
  8499. set_shared_orca_http_client(_shared_cloud_http_client)
  8500. # Fix queue items stuck with invalid "aborted" status (should be "cancelled").
  8501. # This can happen when a print was cancelled mid-print on versions before this fix.
  8502. try:
  8503. async with async_session() as db:
  8504. from backend.app.models.print_queue import PrintQueueItem
  8505. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.status == "aborted"))
  8506. aborted_items = result.scalars().all()
  8507. if aborted_items:
  8508. for item in aborted_items:
  8509. item.status = "cancelled"
  8510. await db.commit()
  8511. logging.info("Fixed %d queue item(s) with invalid 'aborted' status → 'cancelled'", len(aborted_items))
  8512. except Exception as e:
  8513. logging.warning("Failed to fix aborted queue items: %s", e)
  8514. # Restore debug logging state from previous session
  8515. await init_debug_logging()
  8516. # Set up printer manager callbacks
  8517. loop = asyncio.get_event_loop()
  8518. printer_manager.set_event_loop(loop)
  8519. printer_manager.set_status_change_callback(on_printer_status_change)
  8520. printer_manager.set_print_start_callback(on_print_start)
  8521. printer_manager.set_print_complete_callback(on_print_complete)
  8522. printer_manager.set_print_running_observed_callback(on_print_running_observed)
  8523. printer_manager.set_finish_photo_moment_callback(on_finish_photo_moment)
  8524. printer_manager.set_ams_change_callback(on_ams_change)
  8525. printer_manager.set_fts_inlet_change_callback(on_fts_inlet_change)
  8526. # Rehydrate persisted awaiting-plate-clear gate (#961) so prompts survive restarts
  8527. await printer_manager.load_awaiting_plate_clear_from_db()
  8528. # Layer change callback for external camera timelapse
  8529. async def on_layer_change(printer_id: int, layer_num: int):
  8530. """Capture timelapse frame on layer change + first layer notification."""
  8531. from backend.app.services.layer_timelapse import on_layer_change as tl_layer_change
  8532. await tl_layer_change(printer_id, layer_num)
  8533. # #1867: bank a recent in-print frame so the finish-photo path has a
  8534. # pre-End-G-code image to use instead of a live grab of a swapped plate.
  8535. # #2547 added `on_print_progress` as a second driver — this one alone
  8536. # stops firing once the final layer begins.
  8537. await _maybe_bank_inprint_frame(printer_id, layer_num)
  8538. # First layer complete notification (layer_num >= 2 means layer 1 is done).
  8539. # Gate on actual printing state — Bambu firmware ticks layer_num during
  8540. # the pre-print calibration sequence (homing / mesh-level / bed scan /
  8541. # nozzle clean), so a bare layer_num check can fire minutes before the
  8542. # first real extrusion. We require gcode_state == RUNNING and
  8543. # mc_print_sub_stage in (0 = "Printing", None) so calibration sub-stages
  8544. # (1, 9, 14, ...) are excluded. The window widens to [2, 10] because if
  8545. # the layer counter advanced past 2 during PREPARE, the next on_layer_change
  8546. # edge fires later; _first_layer_notified stays clear until we actually send
  8547. # so a deferred re-evaluation can win. See issue #1837.
  8548. if 2 <= layer_num <= 10 and not _first_layer_notified.get(printer_id, False):
  8549. client = printer_manager.get_client(printer_id)
  8550. state = client.state if client else None
  8551. if not state or state.state != "RUNNING":
  8552. return
  8553. if state.mc_print_sub_stage not in (None, 0):
  8554. return
  8555. _first_layer_notified[printer_id] = True
  8556. try:
  8557. async with async_session() as db:
  8558. from backend.app.models.printer import Printer
  8559. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  8560. printer = result.scalar_one_or_none()
  8561. if not printer:
  8562. return
  8563. printer_name = printer.name
  8564. filename = (state.subtask_name or state.gcode_file or "Unknown") if state else "Unknown"
  8565. total_layers = state.total_layers if state else 0
  8566. image_data = await _capture_snapshot_for_notification(
  8567. printer_id, printer, logging.getLogger(__name__)
  8568. )
  8569. await notification_service.on_first_layer_complete(
  8570. printer_id, printer_name, filename, total_layers, db, image_data=image_data
  8571. )
  8572. except Exception as e:
  8573. logging.getLogger(__name__).warning("First layer notification failed: %s", e)
  8574. printer_manager.set_layer_change_callback(on_layer_change)
  8575. async def on_print_progress(printer_id: int, percent: int):
  8576. """#2547: keep the in-print frame bank fresh through the final layer.
  8577. `on_layer_change` stops the moment the last layer starts, which on the
  8578. H2C capture that closed #2547 left the bank stale for the three minutes
  8579. that layer took. Progress is the only field that keeps advancing there,
  8580. and it freezes before the End G-code runs — so banking on it stays
  8581. inside the print and never sees a swapped plate.
  8582. """
  8583. client = printer_manager.get_client(printer_id)
  8584. state = client.state if client else None
  8585. await _maybe_bank_inprint_frame(printer_id, state.layer_num if state else 0)
  8586. printer_manager.set_print_progress_callback(on_print_progress)
  8587. # Event-driven bed cooldown: fires whenever bed_temper arrives via MQTT
  8588. async def on_bed_temp_update(printer_id: int, bed_temp: float):
  8589. waiter = _bed_cool_waiters.get(printer_id)
  8590. if not waiter:
  8591. return
  8592. threshold = waiter["threshold"]
  8593. if bed_temp > threshold:
  8594. return
  8595. # Bed is at or below threshold — fire notification and remove waiter
  8596. waiter_info = _bed_cool_waiters.pop(printer_id, None)
  8597. if not waiter_info:
  8598. return # Another callback already handled it
  8599. bed_cool_logger = logging.getLogger(__name__)
  8600. bed_cool_logger.info(
  8601. "[BED-COOL] Bed cooled to %.1f°C on printer %s (threshold: %.0f°C)",
  8602. bed_temp,
  8603. printer_id,
  8604. threshold,
  8605. )
  8606. try:
  8607. printer_info = printer_manager.get_printer(printer_id)
  8608. p_name = printer_info.name if printer_info else "Unknown"
  8609. async with async_session() as db:
  8610. await notification_service.on_bed_cooled(
  8611. printer_id=printer_id,
  8612. printer_name=p_name,
  8613. bed_temp=bed_temp,
  8614. threshold=threshold,
  8615. filename=waiter_info["filename"],
  8616. db=db,
  8617. )
  8618. except Exception as e:
  8619. bed_cool_logger.warning("[BED-COOL] Failed to send notification: %s", e)
  8620. printer_manager.set_bed_temp_update_callback(on_bed_temp_update)
  8621. async def on_drying_complete(printer_id: int, ams_id: int):
  8622. """Smart-plug auto-off-after-drying trigger (#1349).
  8623. Fires once per AMS unit when ``dry_time`` falls from >0 to 0. The
  8624. manager walks all plugs linked to this printer and turns off only
  8625. the ones with ``auto_off_after_drying`` enabled, after their
  8626. per-plug delay. Multiple AMS units finishing close together (e.g. a
  8627. dual-AMS dry that ends within the same MQTT push) call this once
  8628. per unit — the manager's ``_cancel_pending_off`` collapses
  8629. repeated scheduling on the same plug to one timer, so duplicate
  8630. fires are safe.
  8631. """
  8632. try:
  8633. async with async_session() as db:
  8634. await smart_plug_manager.on_drying_complete(printer_id, db)
  8635. except Exception as e:
  8636. logging.getLogger(__name__).warning(
  8637. "Failed to schedule auto-off-after-drying for printer %d (AMS %d): %s",
  8638. printer_id,
  8639. ams_id,
  8640. e,
  8641. )
  8642. printer_manager.set_drying_complete_callback(on_drying_complete)
  8643. async def on_assignment_verified(printer_id: int, ams_id: int, tray_id: int, verified: bool, detail: dict):
  8644. """Surface the read-back result of a spool assignment to the UI (#2582).
  8645. The MQTT client confirms (or fails to confirm) that the tray telemetry
  8646. echoed back the filament id we pushed. We relay that as a websocket
  8647. event so the frontend can toast "loaded" / "assignment didn't take"
  8648. instead of the historic silent fire-and-forget, which made the
  8649. AMS→Studio hand-off feel random to users.
  8650. """
  8651. try:
  8652. from backend.app.services.spool_assignment_notifications import (
  8653. _slot_label_from_global_tray,
  8654. )
  8655. if ams_id == 255:
  8656. global_id = 254 + tray_id
  8657. elif ams_id >= 128:
  8658. global_id = ams_id
  8659. else:
  8660. global_id = ams_id * 4 + tray_id
  8661. slot_label = _slot_label_from_global_tray(global_id)
  8662. printer_info = printer_manager.get_printer(printer_id)
  8663. printer_name = printer_info.name if printer_info else f"Printer {printer_id}"
  8664. await ws_manager.broadcast(
  8665. {
  8666. "type": "spool_assignment_verified",
  8667. "printer_id": printer_id,
  8668. "printer_name": printer_name,
  8669. "ams_id": ams_id,
  8670. "tray_id": tray_id,
  8671. "slot": slot_label,
  8672. "verified": verified,
  8673. # Present on success: False means the filament setting landed
  8674. # but the K-profile (cali_idx) did not — the reporter's exact
  8675. # "loaded but no flow profile" symptom.
  8676. "kprofile_applied": detail.get("kprofile_applied", True),
  8677. # Present on failure: whether any tray telemetry was seen in
  8678. # the window (distinguishes "printer silent" from "printer
  8679. # stored something else").
  8680. "saw_tray": detail.get("saw_tray", False),
  8681. }
  8682. )
  8683. except Exception as e:
  8684. logging.getLogger(__name__).warning(
  8685. "Failed to broadcast assignment verification for printer %d AMS%d-T%d: %s",
  8686. printer_id,
  8687. ams_id,
  8688. tray_id,
  8689. e,
  8690. )
  8691. printer_manager.set_assignment_verified_callback(on_assignment_verified)
  8692. async def on_tray_change(printer_id: int, tray_global: int, layer_num: int):
  8693. """Persist a mid-print tray change for completion-time attribution.
  8694. AMS filament backup switches trays without telling the slicer, so the
  8695. tray-change log is the only record of which spool fed which layers.
  8696. Keeping it only in memory meant a restart mid-print charged everything
  8697. to the tray that finished the job.
  8698. """
  8699. try:
  8700. from backend.app.services.usage_tracker import record_tray_change
  8701. async with async_session() as db:
  8702. await record_tray_change(db, printer_id, tray_global, layer_num)
  8703. except Exception as e:
  8704. logging.getLogger(__name__).warning(
  8705. "Failed to persist tray change for printer %d (tray=%d, layer=%d): %s",
  8706. printer_id,
  8707. tray_global,
  8708. layer_num,
  8709. e,
  8710. )
  8711. printer_manager.set_tray_change_callback(on_tray_change)
  8712. # Initialize MQTT relay from settings
  8713. async with async_session() as db:
  8714. from backend.app.api.routes.settings import get_setting
  8715. mqtt_settings = {
  8716. "mqtt_enabled": (await get_setting(db, "mqtt_enabled") or "false") == "true",
  8717. "mqtt_broker": await get_setting(db, "mqtt_broker") or "",
  8718. "mqtt_port": int(await get_setting(db, "mqtt_port") or "1883"),
  8719. "mqtt_username": await get_setting(db, "mqtt_username") or "",
  8720. "mqtt_password": await get_setting(db, "mqtt_password") or "",
  8721. "mqtt_topic_prefix": await get_setting(db, "mqtt_topic_prefix") or "bambuddy",
  8722. "mqtt_use_tls": (await get_setting(db, "mqtt_use_tls") or "false") == "true",
  8723. }
  8724. await mqtt_relay.configure(mqtt_settings)
  8725. # Restore MQTT smart plug subscriptions
  8726. if mqtt_settings.get("mqtt_enabled"):
  8727. from backend.app.models.smart_plug import SmartPlug
  8728. from backend.app.services.mqtt_smart_plug import subscribe_plug_to_mqtt
  8729. result = await db.execute(select(SmartPlug).where(SmartPlug.plug_type == "mqtt"))
  8730. mqtt_plugs = result.scalars().all()
  8731. restored = 0
  8732. for plug in mqtt_plugs:
  8733. if subscribe_plug_to_mqtt(mqtt_relay.smart_plug_service, plug):
  8734. restored += 1
  8735. if restored:
  8736. logging.info("Restored %s MQTT smart plug subscriptions", restored)
  8737. # Connect to all active printers
  8738. async with async_session() as db:
  8739. await init_printer_connections(db)
  8740. # Auto-connect to Spoolman if enabled
  8741. async with async_session() as db:
  8742. from backend.app.api.routes.settings import get_setting
  8743. spoolman_enabled = await get_setting(db, "spoolman_enabled")
  8744. spoolman_url = await get_setting(db, "spoolman_url")
  8745. if spoolman_enabled and spoolman_enabled.lower() == "true" and spoolman_url:
  8746. try:
  8747. client = await init_spoolman_client(spoolman_url)
  8748. if await client.health_check():
  8749. logging.info("Auto-connected to Spoolman at %s", spoolman_url)
  8750. # Ensure the 'tag' extra field exists for RFID/UUID storage
  8751. field_ok = await client.ensure_tag_extra_field()
  8752. if not field_ok:
  8753. logging.error("Spoolman tag extra field registration failed — NFC tag links may not persist")
  8754. # Register the BambuStudio slicer-preset fields used by the
  8755. # spool-edit / assign flow. Spoolman rejects PATCHes with
  8756. # unknown extra keys, so these must exist before any update
  8757. # that touches them.
  8758. for field_name in ("bambu_slicer_filament", "bambu_slicer_filament_name"):
  8759. if not await client.ensure_extra_field(field_name):
  8760. logging.warning(
  8761. "Spoolman extra field %r registration failed — "
  8762. "spool slicer-preset edits will return 502",
  8763. field_name,
  8764. )
  8765. else:
  8766. logging.warning("Spoolman at %s is not reachable", spoolman_url)
  8767. except Exception as e:
  8768. logging.warning("Failed to auto-connect to Spoolman: %s", e)
  8769. # Start the print scheduler
  8770. spawn_background_task(print_scheduler.run(), name="print-scheduler")
  8771. # Start the smart plug scheduler for time-based on/off
  8772. smart_plug_manager.start_scheduler()
  8773. # Start the Home Assistant sensor poller (#1148)
  8774. ha_sensor_manager.start()
  8775. location_ha_sensor_manager.start()
  8776. # Resume any pending auto-offs that were interrupted by restart
  8777. await smart_plug_manager.resume_pending_auto_offs()
  8778. # Start the notification digest scheduler
  8779. notification_service.start_digest_scheduler()
  8780. # Start the Telegram reaction pollers (#3046), one per bot token used by a
  8781. # provider in reactions/both mode; the notification routes resync them.
  8782. # Never fatal: a bad provider row or a DB hiccup here costs reactions
  8783. # until the next provider save, not the whole startup.
  8784. try:
  8785. await telegram_reaction_poller.start()
  8786. except Exception as e:
  8787. logging.warning("Telegram reaction poller did not start: %s", e)
  8788. # Start the GitHub backup scheduler
  8789. await github_backup_service.start_scheduler()
  8790. # Start the local backup scheduler
  8791. await local_backup_service.start_scheduler()
  8792. await obico_detection_service.start()
  8793. # Start the library trash sweeper (#1008)
  8794. await library_trash_service.start_scheduler()
  8795. # Start the archive auto-purge sweeper (#1008 follow-up)
  8796. await archive_purge_service.start_scheduler()
  8797. # Start AMS history recording
  8798. start_ams_history_recording()
  8799. # Start printer sensor (nozzle / bed / chamber) history recording
  8800. start_printer_sensor_history_recording()
  8801. # Start printer runtime tracking
  8802. start_runtime_tracking()
  8803. # Start SpoolBuddy device watchdog
  8804. start_spoolbuddy_watchdog()
  8805. # Start camera stream orphan cleanup
  8806. start_camera_cleanup()
  8807. # Start the backstop for MQTT sessions paho has stopped recovering (#2732)
  8808. start_connection_watchdog()
  8809. # One-shot sweep for timelapse session directories orphaned by a crash
  8810. # or restart that happened mid-print (in-memory session tracking can't
  8811. # survive that, and nothing else reaps the leftover frames/output file)
  8812. try:
  8813. from backend.app.services.layer_timelapse import cleanup_orphaned_timelapse_sessions
  8814. removed = cleanup_orphaned_timelapse_sessions()
  8815. if removed:
  8816. logging.getLogger(__name__).info("Removed %d orphaned timelapse session artifact(s)", removed)
  8817. except Exception as e:
  8818. logging.getLogger(__name__).warning("Orphaned timelapse session cleanup failed: %s", e)
  8819. # Start expected-print TTL eviction (prevents memory leak when prints are
  8820. # registered but on_print_start never fires)
  8821. start_expected_prints_cleanup()
  8822. # L-2: Start periodic auth cleanup (stale TOTP + expired revoked JTIs)
  8823. start_auth_cleanup()
  8824. # Maintainer announcements: a signed feed fetched from GitHub every few hours.
  8825. from backend.app.services import announcements as announcements_service
  8826. announcements_service.start()
  8827. from backend.app.services.printer_media import start_printer_download_cleanup
  8828. start_printer_download_cleanup()
  8829. # Event-loop stall watchdog: dumps all thread stacks to stderr if the loop
  8830. # freezes (#1486 — silent "container hangs after adding a printer" reports).
  8831. from backend.app.services.loop_watchdog import start_loop_watchdog
  8832. start_loop_watchdog()
  8833. # Initialize virtual printer manager and sync from DB
  8834. from backend.app.services.virtual_printer import virtual_printer_manager
  8835. virtual_printer_manager.set_session_factory(async_session)
  8836. virtual_printer_manager.set_printer_manager(printer_manager)
  8837. try:
  8838. await virtual_printer_manager.sync_from_db()
  8839. logging.info("Virtual printer manager synced from database")
  8840. except Exception as e:
  8841. logging.warning("Failed to sync virtual printers: %s", e)
  8842. yield
  8843. # Shutdown
  8844. print_scheduler.stop()
  8845. smart_plug_manager.stop_scheduler()
  8846. ha_sensor_manager.stop()
  8847. location_ha_sensor_manager.stop()
  8848. notification_service.stop_digest_scheduler()
  8849. await telegram_reaction_poller.aclose()
  8850. github_backup_service.stop_scheduler()
  8851. local_backup_service.stop_scheduler()
  8852. library_trash_service.stop_scheduler()
  8853. archive_purge_service.stop_scheduler()
  8854. obico_detection_service.stop()
  8855. stop_ams_history_recording()
  8856. stop_printer_sensor_history_recording()
  8857. stop_runtime_tracking()
  8858. stop_spoolbuddy_watchdog()
  8859. stop_camera_cleanup()
  8860. stop_connection_watchdog()
  8861. from backend.app.services.loop_watchdog import stop_loop_watchdog
  8862. stop_loop_watchdog()
  8863. # Tear down all camera fan-out broadcasters (#1089) so subscribers exit
  8864. # cleanly rather than waiting on a queue that nothing will ever fill.
  8865. try:
  8866. from backend.app.services.camera_fanout import shutdown_all_broadcasters
  8867. await shutdown_all_broadcasters()
  8868. except Exception as e:
  8869. logging.warning("Failed to shut down camera broadcasters: %s", e)
  8870. stop_expected_prints_cleanup()
  8871. stop_auth_cleanup()
  8872. from backend.app.services import announcements as announcements_service
  8873. announcements_service.stop()
  8874. from backend.app.services.printer_media import stop_printer_download_cleanup
  8875. await stop_printer_download_cleanup()
  8876. printer_manager.disconnect_all()
  8877. slot_unlink_grace.reset()
  8878. await close_spoolman_client()
  8879. # Stop all virtual printer services
  8880. await virtual_printer_manager.stop_all()
  8881. await mqtt_smart_plug_service.disconnect(timeout=2)
  8882. await mqtt_relay.disconnect(timeout=2)
  8883. # Drop the shared Bambu Cloud HTTP client we registered at startup.
  8884. set_shared_http_client(None)
  8885. set_shared_makerworld_http_client(None)
  8886. set_shared_orca_http_client(None)
  8887. await _shared_cloud_http_client.aclose()
  8888. # Checkpoint WAL (SQLite only) and close all database connections
  8889. from backend.app.core.db_dialect import is_sqlite
  8890. if is_sqlite():
  8891. try:
  8892. async with engine.begin() as conn:
  8893. await conn.execute(text("PRAGMA wal_checkpoint(TRUNCATE)"))
  8894. logging.info("WAL checkpoint completed")
  8895. except Exception as e:
  8896. logging.warning("WAL checkpoint failed: %s", e)
  8897. await engine.dispose()
  8898. app = FastAPI(
  8899. title=app_settings.app_name,
  8900. description="Archive and manage Bambu Lab 3MF files",
  8901. version=APP_VERSION,
  8902. lifespan=lifespan,
  8903. )
  8904. # =============================================================================
  8905. # Authentication Middleware - Secures ALL API routes by default
  8906. # =============================================================================
  8907. # Public routes that don't require authentication even when auth is enabled
  8908. PUBLIC_API_ROUTES = {
  8909. # Auth routes needed before/during login
  8910. "/api/v1/auth/status",
  8911. "/api/v1/auth/login",
  8912. "/api/v1/auth/setup", # Needed for initial setup and recovery
  8913. # Advanced auth status needed for login page
  8914. "/api/v1/auth/advanced-auth/status",
  8915. "/api/v1/auth/forgot-password", # Password reset for advanced auth
  8916. "/api/v1/auth/forgot-password/confirm", # Complete password reset with token (H-6)
  8917. # 2FA routes that are called BEFORE a JWT is issued (pre-auth flow)
  8918. "/api/v1/auth/2fa/verify", # Exchange pre_auth_token + 2FA code for JWT
  8919. "/api/v1/auth/2fa/email/send", # Send OTP email (pre_auth_token based)
  8920. # OIDC routes that must be reachable without a JWT
  8921. "/api/v1/auth/oidc/providers", # Public list of enabled providers
  8922. "/api/v1/auth/oidc/callback", # Redirect target from OIDC provider
  8923. "/api/v1/auth/oidc/exchange", # Exchange short-lived OIDC token for JWT
  8924. # Connected apps: the app's server swaps a code for the user's identity,
  8925. # authenticated by its client secret rather than a login token.
  8926. "/api/v1/connect/token",
  8927. # Version check for updates (no sensitive data)
  8928. "/api/v1/updates/version",
  8929. # Metrics endpoint handles its own prometheus_token authentication
  8930. "/api/v1/metrics",
  8931. # Appliance bootstrap (#1589 follow-up): the SPA's i18n setup polls
  8932. # this BEFORE a JWT is available to pick up the firstboot wizard's
  8933. # hostname / timezone / locale and the chrony NTP-gate state. The
  8934. # response contains user-set defaults and a public sync flag — no
  8935. # secrets. Without this entry the global auth middleware returns 401
  8936. # before the route handler runs, regardless of the route's own
  8937. # "no auth required" intent.
  8938. "/api/v1/system/appliance",
  8939. # Cam Wall kiosk feed (#2531): a TV or Pi in kiosk mode has no login, so it
  8940. # authenticates with a long-lived ``camwall``-scoped token in the query
  8941. # string — exactly like the camera streams two lists below, and for the same
  8942. # reason (no header to put a JWT in). "Public" here only means the middleware
  8943. # steps aside; the route still runs RequireCamWallTokenIfAuthEnabled, which
  8944. # rejects an absent, expired, revoked, or wrong-scoped token. In particular a
  8945. # plain ``camera_stream`` token does NOT open this door.
  8946. "/api/v1/camwall/printers",
  8947. }
  8948. # Route prefixes that are public (for routes with dynamic segments)
  8949. PUBLIC_API_PREFIXES = [
  8950. # WebSocket connections handle their own auth
  8951. "/api/v1/ws",
  8952. # OIDC authorize redirects — include provider_id in path
  8953. "/api/v1/auth/oidc/authorize/",
  8954. # One-tap outcome-verdict links from push notifications (#1898). Tapped on
  8955. # a phone with no session, so no header can carry a JWT — the single-use
  8956. # capability token in the path IS the credential (same reasoning as the
  8957. # /dl/ slicer downloads below). The route grants nothing beyond writing
  8958. # good/reject on the one archive the token was minted for.
  8959. "/api/v1/archives/confirm/",
  8960. ]
  8961. # Route patterns that are public (read-only display data)
  8962. # These are checked with "in path" - needed because browsers load images/videos
  8963. # via <img src> and <video src> which don't include Authorization headers
  8964. PUBLIC_API_PATTERNS = [
  8965. # Thumbnails
  8966. "/thumbnail", # /archives/{id}/thumbnail, /library/files/{id}/thumbnail
  8967. "/plate-thumbnail/", # /archives/{id}/plate-thumbnail/{plate_id}
  8968. # Images and media
  8969. "/photos/", # /archives/{id}/photos/{filename}
  8970. "/project-image/", # /archives/{id}/project-image/{path}
  8971. "/qrcode", # /archives/{id}/qrcode
  8972. "/timelapse", # /archives/{id}/timelapse (video)
  8973. "/cover", # /printers/{id}/cover
  8974. "/icon", # /external-links/{id}/icon
  8975. # Camera (streams loaded via <img> tag)
  8976. "/camera/stream", # /printers/{id}/camera/stream
  8977. "/camera/snapshot", # /printers/{id}/camera/snapshot
  8978. # Streaming-overlay status feed (#2613): OBS loads /overlay/{id} with no login
  8979. # and this backs it, authenticated by an ``overlay``-scoped token in the query
  8980. # string (same reasoning as the camera streams above — no header to carry a
  8981. # JWT). "Public" only means the middleware steps aside; the route still runs
  8982. # RequireOverlayTokenIfAuthEnabled, which rejects an absent, expired, revoked,
  8983. # or wrong-scoped token — a camwall or camera_stream token does NOT open it.
  8984. "/overlay-status", # /printers/{id}/overlay-status
  8985. # Slicer token-authenticated downloads — protocol handlers (bambustudioopen://,
  8986. # orcaslicer://) cannot send auth headers. These endpoints validate a short-lived
  8987. # download token in the URL path instead.
  8988. "/dl/", # /archives/{id}/dl/{token}/{filename}, /library/files/{id}/dl/{token}/{filename}
  8989. # Same family, but the segment is "source-dl" — which does NOT contain "/dl/",
  8990. # and these patterns match by substring. Without its own entry the middleware
  8991. # 401s the slicer's header-less request before the route's token check runs,
  8992. # so "Open source 3MF in slicer" failed whenever auth was enabled (#3029).
  8993. "/source-dl/", # /archives/{id}/source-dl/{token}/{filename}
  8994. # Obico ML API fetches JPEG frames by one-shot nonce (issue #172 follow-up).
  8995. # The nonce itself is the credential: 32-byte random, single-use, ~30s TTL.
  8996. "/obico/cached-frame/", # /obico/cached-frame/{nonce}
  8997. ]
  8998. _security_headers_logger = logging.getLogger("backend.app.main.security_headers")
  8999. def _parse_trusted_frame_origins() -> tuple[str, ...]:
  9000. """Parse TRUSTED_FRAME_ORIGINS env var into a validated allowlist (#1191).
  9001. Format: comma-separated list of ``scheme://host[:port]`` origins.
  9002. Used by ``security_headers_middleware`` to relax ``frame-ancestors`` for
  9003. trusted same-LAN deployments (e.g. Home Assistant Webpage panel embedding
  9004. Bambuddy from a different port). Defaults to empty — strict ``'none'``.
  9005. Invalid entries are dropped with a warning rather than failing startup, so
  9006. a typo in one origin doesn't take the whole deployment down.
  9007. """
  9008. raw = os.environ.get("TRUSTED_FRAME_ORIGINS", "").strip()
  9009. if not raw:
  9010. return ()
  9011. valid: list[str] = []
  9012. for item in raw.split(","):
  9013. candidate = item.strip()
  9014. if not candidate:
  9015. continue
  9016. try:
  9017. parsed = urlparse(candidate)
  9018. except ValueError as e:
  9019. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — %s", candidate, e)
  9020. continue
  9021. if parsed.scheme not in ("http", "https"):
  9022. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — must be http(s)", candidate)
  9023. continue
  9024. if not parsed.netloc:
  9025. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — missing host", candidate)
  9026. continue
  9027. if parsed.path and parsed.path != "/":
  9028. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — paths not allowed", candidate)
  9029. continue
  9030. if parsed.query or parsed.fragment:
  9031. _security_headers_logger.warning(
  9032. "TRUSTED_FRAME_ORIGINS: dropping %r — query/fragment not allowed", candidate
  9033. )
  9034. continue
  9035. if "*" in parsed.netloc:
  9036. _security_headers_logger.warning("TRUSTED_FRAME_ORIGINS: dropping %r — wildcards not allowed", candidate)
  9037. continue
  9038. valid.append(f"{parsed.scheme}://{parsed.netloc}")
  9039. if valid:
  9040. _security_headers_logger.info("TRUSTED_FRAME_ORIGINS: %s", ", ".join(valid))
  9041. return tuple(valid)
  9042. _TRUSTED_FRAME_ORIGINS: tuple[str, ...] = _parse_trusted_frame_origins()
  9043. def _frame_ancestors(default_value: str) -> str:
  9044. """Compose the ``frame-ancestors`` CSP directive (#1191).
  9045. ``default_value`` is the strict directive used when the operator has not
  9046. configured ``TRUSTED_FRAME_ORIGINS`` — typically ``'none'`` (catch-all and
  9047. docs) or ``'self'`` (the streaming overlay, embedded same-origin by the
  9048. Settings URL builder's preview). When trusted origins
  9049. are configured, ``'self'`` is always included so same-origin embedding never
  9050. breaks even if an operator forgets to add their own origin to the list.
  9051. """
  9052. if _TRUSTED_FRAME_ORIGINS:
  9053. return "frame-ancestors 'self' " + " ".join(_TRUSTED_FRAME_ORIGINS) + ";"
  9054. return f"frame-ancestors {default_value};"
  9055. # The two Vite-emitted worker assets that compile WebAssembly (#2976). Both
  9056. # patterns are anchored on the exact emitted name so the relaxed policies
  9057. # below can never apply to any other asset.
  9058. # src/workers/stepPreview.worker.ts -> /assets/stepPreview.worker-<hash>.js
  9059. # pdfjs-dist/legacy/build/pdf.worker.min.mjs?worker&url
  9060. # -> /assets/pdf.worker.min-<hash>.js
  9061. # Vite also emits a one-line chunk under the second name that only exports the
  9062. # worker's URL. The page imports it as a module, and a module script is run
  9063. # under the importing document's policy, never its own response's, so it
  9064. # matching as well changes nothing.
  9065. _STEP_WORKER_ASSET_RE = re.compile(r"^/assets/stepPreview\.worker-[\w-]+\.js$")
  9066. _PDF_WORKER_ASSET_RE = re.compile(r"^/assets/pdf\.worker\.min-[\w-]+\.js$")
  9067. @app.middleware("http")
  9068. async def security_headers_middleware(request, call_next):
  9069. """Add standard HTTP security headers to every response."""
  9070. # Per-request nonce stamped into `script-src` (#1460). On its own this
  9071. # changes nothing for Bambuddy's own pages — index.html has no inline
  9072. # scripts since the SW registration moved to /sw-register.js. The reason
  9073. # it's here is Cloudflare: a CF-fronted deployment has the bot-detection
  9074. # script injected into the HTML on the edge, with a fresh hash on every
  9075. # load (so hashes can't be allowlisted). When CF sees a nonce in our CSP,
  9076. # it clones the same nonce onto its injected <script>, and the inline
  9077. # script passes the policy without us needing 'unsafe-inline'. See
  9078. # https://developers.cloudflare.com/cloudflare-challenges/challenge-types/javascript-detections/#if-you-have-a-content-security-policy-csp
  9079. csp_nonce = secrets.token_urlsafe(16)
  9080. # Routes that render their own HTML need it too, or their inline script is
  9081. # blocked by the policy below. The outcome-confirmation page (#1898) is the
  9082. # one that does: it submits its own form so a verdict still costs one tap.
  9083. request.state.csp_nonce = csp_nonce
  9084. response = await call_next(request)
  9085. response.headers["X-Content-Type-Options"] = "nosniff"
  9086. # X-Frame-Options is the legacy cross-origin embedding control. Modern
  9087. # browsers honour CSP frame-ancestors instead, and the legacy
  9088. # `ALLOW-FROM <url>` syntax is deprecated and inconsistent across vendors.
  9089. # When operators have explicitly allowlisted trusted frame origins (#1191
  9090. # — typically Home Assistant on a different port), drop X-Frame-Options
  9091. # and let the CSP-side frame-ancestors directive govern embedding.
  9092. if not _TRUSTED_FRAME_ORIGINS:
  9093. response.headers["X-Frame-Options"] = "SAMEORIGIN"
  9094. response.headers["Referrer-Policy"] = "strict-origin-when-cross-origin"
  9095. # Content-Security-Policy for the React SPA.
  9096. # Notes:
  9097. # - 'unsafe-inline' for style-src: React and UI libs inject inline styles at runtime.
  9098. # - connect-src ws:/wss:: MQTT/printer WebSocket connections.
  9099. # - img-src data: / blob:: base64 thumbnails and Blob-URL timelapse previews.
  9100. # - media-src blob:: timelapse video player uses Blob URLs.
  9101. # - font-src data:: some icon fonts are embedded as data URIs.
  9102. if request.url.path in ("/docs", "/redoc", "/docs/oauth2-redirect"):
  9103. # FastAPI's built-in Swagger UI / ReDoc pages load assets from
  9104. # cdn.jsdelivr.net and bootstrap with an inline <script>, so the
  9105. # default CSP would render a blank page.
  9106. response.headers["Content-Security-Policy"] = (
  9107. "default-src 'self'; "
  9108. "script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; "
  9109. "style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net https://fonts.googleapis.com; "
  9110. "img-src 'self' data: blob: https://fastapi.tiangolo.com https://cdn.redoc.ly; "
  9111. "connect-src 'self'; "
  9112. "font-src 'self' data: https://fonts.gstatic.com; "
  9113. "worker-src 'self' blob:; "
  9114. "object-src 'none'; "
  9115. "base-uri 'self'; " + _frame_ancestors("'none'")
  9116. )
  9117. elif _STEP_WORKER_ASSET_RE.match(request.url.path):
  9118. # The STEP preview worker (#2976) runs OpenCascade compiled to WASM;
  9119. # its emscripten/embind glue generates invoker functions with `new
  9120. # Function(...)`, which needs 'unsafe-eval'. Per CSP3 a dedicated
  9121. # worker is governed by the policy delivered with the WORKER SCRIPT's
  9122. # own response — not the document's — so relaxing it here confines
  9123. # eval to that DOM-less worker context. The document policy below
  9124. # stays nonce-strict, and this response header has no effect when the
  9125. # file is merely fetched (a fetch's CSP is enforced against the
  9126. # requesting document, not the resource's own headers).
  9127. response.headers["Content-Security-Policy"] = (
  9128. "default-src 'self'; "
  9129. "script-src 'self' 'wasm-unsafe-eval' 'unsafe-eval'; "
  9130. "connect-src 'self'; "
  9131. "object-src 'none'; "
  9132. "base-uri 'self'; " + _frame_ancestors("'none'")
  9133. )
  9134. elif _PDF_WORKER_ASSET_RE.match(request.url.path):
  9135. # pdf.js decodes JPEG2000/JBIG2 images and ICC colour with WebAssembly
  9136. # and fetches those modules from /assets/pdfjs/wasm/ (#2976). Same CSP3
  9137. # rule as the STEP worker above: the policy that governs a dedicated
  9138. # worker is the one delivered with its own script, so the wasm compile
  9139. # has to be permitted here rather than on the document. Unlike the STEP
  9140. # worker this one needs no JS eval, so it gets 'wasm-unsafe-eval' only.
  9141. response.headers["Content-Security-Policy"] = (
  9142. "default-src 'self'; "
  9143. "script-src 'self' 'wasm-unsafe-eval'; "
  9144. "connect-src 'self'; "
  9145. "object-src 'none'; "
  9146. "base-uri 'self'; " + _frame_ancestors("'none'")
  9147. )
  9148. else:
  9149. # The streaming overlay is embedded same-origin by the URL builder's
  9150. # preview in Settings (#1422), so this branch allows 'self'.
  9151. # Embedding from anywhere else is still refused: 'self'
  9152. # only permits a framer on this origin, which is Bambuddy's own UI, so
  9153. # a clickjacking page on another host is blocked exactly as before.
  9154. # (The overlay draws status over a camera feed and its only interactive
  9155. # element is the logo link, so there is nothing to bait a click into
  9156. # even from a same-origin framer.) Cross-origin embedding of the
  9157. # overlay — Home Assistant on another port — remains what
  9158. # TRUSTED_FRAME_ORIGINS is for, and _frame_ancestors already folds that
  9159. # allowlist in.
  9160. #
  9161. # The connected-app consent page (/connect/authorize) gets the same
  9162. # 'self': an app opened from Bambuddy's sidebar runs in an iframe, and
  9163. # its "Sign in with Bambuddy" navigates that iframe to this page. With
  9164. # 'none' the browser refuses to show it even inside Bambuddy. 'self'
  9165. # requires every ancestor to be this origin, so a foreign page -- a
  9166. # sidebar link's site included -- still cannot frame the consent
  9167. # screen to bait a click.
  9168. embeddable_same_origin = request.url.path.startswith("/overlay/") or request.url.path == "/connect/authorize"
  9169. # No 'wasm-unsafe-eval' here: nothing compiles WebAssembly on the main
  9170. # thread. Both wasm consumers — the STEP preview and pdf.js's image
  9171. # decoders (#2976) — run in dedicated workers, which CSP3 governs by
  9172. # the policy served with their own script, so each gets it in its own
  9173. # branch above and the document policy stays as strict as it was.
  9174. response.headers["Content-Security-Policy"] = (
  9175. "default-src 'self'; "
  9176. f"script-src 'self' 'nonce-{csp_nonce}'; "
  9177. "style-src 'self' 'unsafe-inline'; "
  9178. "img-src 'self' data: blob:; "
  9179. "media-src 'self' blob:; "
  9180. "connect-src 'self' ws: wss:; "
  9181. "font-src 'self' data:; "
  9182. "object-src 'none'; "
  9183. "base-uri 'self'; "
  9184. "frame-src 'self' http: https:; " + _frame_ancestors("'self'" if embeddable_same_origin else "'none'")
  9185. )
  9186. if request.url.scheme == "https":
  9187. response.headers["Strict-Transport-Security"] = "max-age=31536000; includeSubDomains"
  9188. return response
  9189. @app.middleware("http")
  9190. async def auth_middleware(request, call_next):
  9191. """Enforce authentication on all API routes when auth is enabled.
  9192. This middleware provides defense-in-depth by checking auth at the API gateway level,
  9193. regardless of whether individual routes have auth dependencies.
  9194. """
  9195. from starlette.responses import JSONResponse
  9196. path = request.url.path
  9197. # Only apply to API routes
  9198. if not path.startswith("/api/"):
  9199. return await call_next(request)
  9200. # Allow public routes
  9201. if path in PUBLIC_API_ROUTES:
  9202. return await call_next(request)
  9203. # Allow public prefixes
  9204. for prefix in PUBLIC_API_PREFIXES:
  9205. if path.startswith(prefix):
  9206. return await call_next(request)
  9207. # Allow public patterns (read-only display data like thumbnails)
  9208. for pattern in PUBLIC_API_PATTERNS:
  9209. if pattern in path:
  9210. return await call_next(request)
  9211. # Check if auth is enabled. Fail CLOSED on any exception during the
  9212. # probe — GHSA-6mf4-q26m-47pv: the previous fail-open path here let
  9213. # an attacker who could force a DB exception (e.g. file-descriptor
  9214. # exhaustion via login flood) bypass auth on every protected endpoint.
  9215. try:
  9216. async with async_session() as db:
  9217. from backend.app.core.auth import is_auth_enabled
  9218. auth_enabled = await is_auth_enabled(db)
  9219. if not auth_enabled:
  9220. # Auth disabled, allow all requests
  9221. return await call_next(request)
  9222. except Exception:
  9223. logging.getLogger(__name__).exception("auth_middleware: failing closed on auth-probe error from %s", path)
  9224. return JSONResponse(
  9225. status_code=503,
  9226. content={"detail": "Authentication service temporarily unavailable"},
  9227. )
  9228. # Auth is enabled - require valid token
  9229. auth_header = request.headers.get("Authorization")
  9230. x_api_key = request.headers.get("X-API-Key")
  9231. # Check for API key auth first
  9232. if x_api_key or (auth_header and auth_header.startswith("Bearer bb_")):
  9233. # API key authentication - let the request through to be validated by route handler
  9234. # API keys are validated per-route since they have different permission levels
  9235. return await call_next(request)
  9236. # Check for JWT auth
  9237. if not auth_header or not auth_header.startswith("Bearer "):
  9238. return JSONResponse(
  9239. status_code=401,
  9240. content={"detail": "Authentication required"},
  9241. headers={"WWW-Authenticate": "Bearer"},
  9242. )
  9243. # Validate JWT token
  9244. import jwt
  9245. try:
  9246. from backend.app.core.auth import (
  9247. ALGORITHM,
  9248. SECRET_KEY,
  9249. _is_token_fresh,
  9250. get_user_by_username,
  9251. is_jti_revoked,
  9252. )
  9253. token = auth_header.replace("Bearer ", "")
  9254. payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
  9255. username = payload.get("sub")
  9256. if not username:
  9257. raise ValueError("No username in token")
  9258. jti = payload.get("jti")
  9259. if not jti:
  9260. raise ValueError("No jti in token")
  9261. iat = payload.get("iat")
  9262. # Verify user exists, is active, and token is still fresh (L-R8-A).
  9263. # Reject revoked tokens first (defense-in-depth gateway check), reusing
  9264. # this session so the gateway adds a single pooled checkout, not two (#2572).
  9265. async with async_session() as db:
  9266. if await is_jti_revoked(jti, db):
  9267. return JSONResponse(
  9268. status_code=401,
  9269. content={"detail": "Token has been revoked"},
  9270. headers={"WWW-Authenticate": "Bearer"},
  9271. )
  9272. user = await get_user_by_username(db, username)
  9273. if not user or not user.is_active:
  9274. return JSONResponse(
  9275. status_code=401,
  9276. content={"detail": "User not found or inactive"},
  9277. headers={"WWW-Authenticate": "Bearer"},
  9278. )
  9279. if not _is_token_fresh(iat, user):
  9280. return JSONResponse(
  9281. status_code=401,
  9282. content={"detail": "Token no longer valid"},
  9283. headers={"WWW-Authenticate": "Bearer"},
  9284. )
  9285. except jwt.ExpiredSignatureError:
  9286. return JSONResponse(
  9287. status_code=401,
  9288. content={"detail": "Token has expired"},
  9289. headers={"WWW-Authenticate": "Bearer"},
  9290. )
  9291. except (jwt.InvalidTokenError, ValueError, Exception):
  9292. return JSONResponse(
  9293. status_code=401,
  9294. content={"detail": "Invalid token"},
  9295. headers={"WWW-Authenticate": "Bearer"},
  9296. )
  9297. return await call_next(request)
  9298. @app.middleware("http")
  9299. async def trace_id_middleware(request, call_next):
  9300. """Stamp every HTTP request with a trace ID and echo it back.
  9301. Decorated AFTER auth_middleware on purpose: Starlette stacks
  9302. @app.middleware decorators LIFO, so the last-decorated runs first
  9303. inbound. Putting the trace stamp last makes it the OUTERMOST layer,
  9304. which means auth-middleware log lines (and every line emitted on the
  9305. way down to and back from the route handler) all carry the same
  9306. trace ID. If we put it before auth, auth's logs would be stamped
  9307. with the *previous* request's ID — useless for correlation.
  9308. Honours an inbound ``X-Trace-Id`` header so callers running their
  9309. own tracing can correlate their span IDs with our log lines, but
  9310. only if the value passes the whitelist gate in
  9311. ``backend.app.core.trace.normalise_inbound_trace_id`` — anything
  9312. rejected (too long, contains control chars, etc.) silently triggers
  9313. a freshly minted server-side ID rather than failing the request.
  9314. The minted (or echoed) ID is set on a ContextVar so that every log
  9315. record emitted during the request — application logs *and* uvicorn's
  9316. access log — carries it via TraceIDFilter, and is also written to
  9317. the ``X-Trace-Id`` response header so clients can pin a server-side
  9318. log search to the exact request they made.
  9319. """
  9320. from backend.app.core.trace import (
  9321. generate_trace_id,
  9322. normalise_inbound_trace_id,
  9323. trace_id_var,
  9324. )
  9325. inbound = normalise_inbound_trace_id(request.headers.get("X-Trace-Id"))
  9326. trace_id = inbound if inbound is not None else generate_trace_id()
  9327. token = trace_id_var.set(trace_id)
  9328. try:
  9329. response = await call_next(request)
  9330. finally:
  9331. # Reset the ContextVar so a record emitted in a totally
  9332. # unrelated background task that just happens to inherit this
  9333. # context doesn't keep referencing this request's ID forever.
  9334. # In practice ContextVar.reset is best-effort under asyncio
  9335. # task-spawn semantics, but the cost is one attribute write so
  9336. # we may as well do it.
  9337. trace_id_var.reset(token)
  9338. response.headers["X-Trace-Id"] = trace_id
  9339. return response
  9340. # API routes
  9341. app.include_router(auth.router, prefix=app_settings.api_prefix)
  9342. app.include_router(mfa.router, prefix=app_settings.api_prefix)
  9343. app.include_router(bug_report.router, prefix=app_settings.api_prefix)
  9344. app.include_router(users.router, prefix=app_settings.api_prefix)
  9345. app.include_router(groups.router, prefix=app_settings.api_prefix)
  9346. app.include_router(printers.router, prefix=app_settings.api_prefix)
  9347. app.include_router(archives.router, prefix=app_settings.api_prefix)
  9348. app.include_router(filaments.router, prefix=app_settings.api_prefix)
  9349. app.include_router(finance.router, prefix=app_settings.api_prefix)
  9350. app.include_router(inventory.router, prefix=app_settings.api_prefix)
  9351. app.include_router(labels.router, prefix=app_settings.api_prefix)
  9352. app.include_router(settings_routes.router, prefix=app_settings.api_prefix)
  9353. app.include_router(cloud.router, prefix=app_settings.api_prefix)
  9354. app.include_router(orca_cloud.router, prefix=app_settings.api_prefix)
  9355. app.include_router(local_presets.router, prefix=app_settings.api_prefix)
  9356. app.include_router(smart_plugs.router, prefix=app_settings.api_prefix)
  9357. app.include_router(ha_sensors.router, prefix=app_settings.api_prefix)
  9358. app.include_router(location_ha_sensors.router, prefix=app_settings.api_prefix)
  9359. app.include_router(print_log.router, prefix=app_settings.api_prefix)
  9360. app.include_router(print_queue.router, prefix=app_settings.api_prefix)
  9361. app.include_router(scheduled_dryings.router, prefix=app_settings.api_prefix)
  9362. app.include_router(kprofiles.router, prefix=app_settings.api_prefix)
  9363. app.include_router(notifications.router, prefix=app_settings.api_prefix)
  9364. app.include_router(notification_templates.router, prefix=app_settings.api_prefix)
  9365. app.include_router(user_notifications.router, prefix=app_settings.api_prefix)
  9366. app.include_router(spoolman.router, prefix=app_settings.api_prefix)
  9367. app.include_router(spoolman_inventory.router, prefix=app_settings.api_prefix)
  9368. app.include_router(updates.router, prefix=app_settings.api_prefix)
  9369. app.include_router(sponsor_prompt.router, prefix=app_settings.api_prefix)
  9370. app.include_router(announcements.router, prefix=app_settings.api_prefix)
  9371. app.include_router(maintenance.router, prefix=app_settings.api_prefix)
  9372. app.include_router(camera.router, prefix=app_settings.api_prefix)
  9373. app.include_router(camwall.router, prefix=app_settings.api_prefix)
  9374. app.include_router(external_links.router, prefix=app_settings.api_prefix)
  9375. app.include_router(projects.router, prefix=app_settings.api_prefix)
  9376. app.include_router(library.router, prefix=app_settings.api_prefix)
  9377. app.include_router(library_tags.router, prefix=app_settings.api_prefix)
  9378. app.include_router(library_trash.router, prefix=app_settings.api_prefix)
  9379. app.include_router(library_variants.router, prefix=app_settings.api_prefix)
  9380. app.include_router(slice_jobs.router, prefix=app_settings.api_prefix)
  9381. app.include_router(slicer_pipelines.router, prefix=app_settings.api_prefix)
  9382. app.include_router(pipeline_runs.pipeline_run_create_router, prefix=app_settings.api_prefix)
  9383. app.include_router(pipeline_runs.pipeline_run_router, prefix=app_settings.api_prefix)
  9384. app.include_router(slicer_presets.router, prefix=app_settings.api_prefix)
  9385. app.include_router(archive_purge.router, prefix=app_settings.api_prefix)
  9386. app.include_router(makerworld.router, prefix=app_settings.api_prefix)
  9387. app.include_router(api_keys.router, prefix=app_settings.api_prefix)
  9388. app.include_router(connected_apps.router, prefix=app_settings.api_prefix)
  9389. app.include_router(webhook.router, prefix=app_settings.api_prefix)
  9390. app.include_router(ams_history.router, prefix=app_settings.api_prefix)
  9391. app.include_router(printer_sensor_history.router, prefix=app_settings.api_prefix)
  9392. app.include_router(system.router, prefix=app_settings.api_prefix)
  9393. app.include_router(support.router, prefix=app_settings.api_prefix)
  9394. app.include_router(websocket.router, prefix=app_settings.api_prefix)
  9395. app.include_router(discovery.router, prefix=app_settings.api_prefix)
  9396. app.include_router(pending_uploads.router, prefix=app_settings.api_prefix)
  9397. app.include_router(firmware.router, prefix=app_settings.api_prefix)
  9398. app.include_router(github_backup.router, prefix=app_settings.api_prefix)
  9399. app.include_router(local_backup.router, prefix=app_settings.api_prefix)
  9400. app.include_router(obico.router, prefix=app_settings.api_prefix)
  9401. app.include_router(metrics.router, prefix=app_settings.api_prefix)
  9402. app.include_router(virtual_printers.router, prefix=app_settings.api_prefix)
  9403. app.include_router(spoolbuddy.router, prefix=app_settings.api_prefix)
  9404. # Serve static files (React build)
  9405. if app_settings.static_dir.exists() and any(app_settings.static_dir.iterdir()):
  9406. app.mount(
  9407. "/assets",
  9408. StaticFiles(directory=app_settings.static_dir / "assets"),
  9409. name="assets",
  9410. )
  9411. if (app_settings.static_dir / "img").exists():
  9412. app.mount(
  9413. "/img",
  9414. StaticFiles(directory=app_settings.static_dir / "img"),
  9415. name="img",
  9416. )
  9417. if (app_settings.static_dir / "icons").exists():
  9418. app.mount(
  9419. "/icons",
  9420. StaticFiles(directory=app_settings.static_dir / "icons"),
  9421. name="icons",
  9422. )
  9423. # Self-hosted Inter woff2 files (#1460). Without this mount /fonts/*.woff2
  9424. # falls through to the SPA catch-all and returns index.html, which the
  9425. # browser's font sanitizer rejects ("downloadable font: rejected by
  9426. # sanitizer").
  9427. if (app_settings.static_dir / "fonts").exists():
  9428. app.mount(
  9429. "/fonts",
  9430. StaticFiles(directory=app_settings.static_dir / "fonts"),
  9431. name="fonts",
  9432. )
  9433. @app.get("/")
  9434. async def serve_frontend():
  9435. """Serve the React frontend."""
  9436. index_file = app_settings.static_dir / "index.html"
  9437. if index_file.exists():
  9438. return FileResponse(index_file, headers=_HTML_CACHE_HEADERS)
  9439. return {
  9440. "message": "Bambuddy API",
  9441. "docs": "/docs",
  9442. "frontend": "Build and place React app in /static directory",
  9443. }
  9444. # index.html must always be revalidated — Vite emits content-hashed JS/CSS
  9445. # bundles (e.g. `index-JRaF_JhW.js`), so the JS itself is safe to cache
  9446. # forever, but the HTML wrapping it is the only file that knows which hash
  9447. # is current. Without explicit cache-control headers Chromium decides
  9448. # heuristically (typically 10% of the time since Last-Modified) and on
  9449. # long-running kiosks happily serves stale HTML across browser restarts.
  9450. # That stale HTML references an old bundle hash, the old bundle is also
  9451. # in the disk cache, and the user ends up running pre-update JS forever
  9452. # without ever knowing why. ``no-cache`` (revalidate every time, but a
  9453. # 304 is cheap) is the correct setting for an SPA's entry HTML.
  9454. _HTML_CACHE_HEADERS = {"Cache-Control": "no-cache, must-revalidate"}
  9455. @app.get("/health")
  9456. async def health_check():
  9457. """Health check endpoint."""
  9458. return {"status": "healthy"}
  9459. # GET + HEAD on the three PWA bootstrap routes (#1460). Scanners and a plain
  9460. # `curl -I` use HEAD; FastAPI's @app.get only registers GET, so HEAD answers
  9461. # with 405 Method Not Allowed and shows up as a "broken manifest" red herring
  9462. # in deployment debugging.
  9463. @app.api_route("/manifest.json", methods=["GET", "HEAD"])
  9464. async def serve_manifest():
  9465. """Serve PWA manifest."""
  9466. manifest_file = app_settings.static_dir / "manifest.json"
  9467. if manifest_file.exists():
  9468. return FileResponse(manifest_file, media_type="application/manifest+json")
  9469. return {"error": "Manifest not found"}
  9470. @app.api_route("/sw.js", methods=["GET", "HEAD"])
  9471. async def serve_service_worker():
  9472. """Serve service worker."""
  9473. sw_file = app_settings.static_dir / "sw.js"
  9474. if sw_file.exists():
  9475. return FileResponse(
  9476. sw_file,
  9477. media_type="application/javascript",
  9478. headers={"Cache-Control": "no-cache, no-store, must-revalidate"},
  9479. )
  9480. return {"error": "Service worker not found"}
  9481. @app.api_route("/sw-register.js", methods=["GET", "HEAD"])
  9482. async def serve_sw_register():
  9483. """Serve the service-worker registration bootstrap script.
  9484. Served as a real JS file so the strict `script-src 'self'` CSP covers it
  9485. without needing 'unsafe-inline' or per-build hashes on the inline tag.
  9486. """
  9487. reg_file = app_settings.static_dir / "sw-register.js"
  9488. if reg_file.exists():
  9489. return FileResponse(reg_file, media_type="application/javascript")
  9490. return {"error": "sw-register.js not found"}
  9491. # ── GCode viewer static files ────────────────────────────────────────────────
  9492. # Catch-all route for React Router (must be last)
  9493. @app.get("/{full_path:path}")
  9494. async def serve_spa(full_path: str):
  9495. """Serve React app for client-side routing."""
  9496. # Don't intercept API routes - raise proper 404 so FastAPI can handle redirects
  9497. if full_path.startswith("api/"):
  9498. from fastapi import HTTPException
  9499. raise HTTPException(status_code=404, detail="Not found")
  9500. index_file = app_settings.static_dir / "index.html"
  9501. if index_file.exists():
  9502. return FileResponse(index_file, headers=_HTML_CACHE_HEADERS)
  9503. return {"error": "Frontend not built"}