1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673 |
- /*
- * mbsync - mailbox synchronizer
- * Copyright (C) 2000-2002 Michael R. Elkins <me@mutt.org>
- * Copyright (C) 2002-2006,2008,2010-2013 Oswald Buddenhagen <ossi@users.sf.net>
- * Copyright (C) 2004 Theodore Y. Ts'o <tytso@mit.edu>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- * As a special exception, mbsync may be linked with the OpenSSL library,
- * despite that library's more restrictive license.
- */
- #include "driver.h"
- #include "socket.h"
- #include <assert.h>
- #include <unistd.h>
- #include <stdlib.h>
- #include <stdio.h>
- #include <stddef.h>
- #include <limits.h>
- #include <string.h>
- #include <ctype.h>
- #include <time.h>
- #include <sys/wait.h>
- #ifdef HAVE_LIBSASL
- # include <sasl/sasl.h>
- # include <sasl/saslutil.h>
- #endif
- #ifdef HAVE_MACOS_KEYCHAIN
- # include <Security/Security.h>
- #endif
- #ifdef HAVE_LIBSSL
- enum { SSL_None, SSL_STARTTLS, SSL_IMAPS };
- #endif
- typedef struct imap_server_conf {
- struct imap_server_conf *next;
- char *name;
- server_conf_t sconf;
- char *user;
- char *user_cmd;
- char *pass;
- char *pass_cmd;
- int max_in_progress;
- uint cap_mask;
- string_list_t *auth_mechs;
- #ifdef HAVE_LIBSSL
- char ssl_type;
- #endif
- #ifdef HAVE_MACOS_KEYCHAIN
- char use_keychain;
- #endif
- char failed;
- } imap_server_conf_t;
- typedef struct {
- store_conf_t gen;
- imap_server_conf_t *server;
- char delimiter;
- char use_namespace;
- char use_lsub;
- } imap_store_conf_t;
- typedef struct {
- message_t gen;
- /* uint seq; will be needed when expunges are tracked */
- } imap_message_t;
- #define NIL (void*)0x1
- #define LIST (void*)0x2
- typedef struct _list {
- struct _list *next, *child;
- char *val;
- uint len;
- } list_t;
- #define MAX_LIST_DEPTH 5
- typedef struct imap_store imap_store_t;
- typedef struct {
- list_t *head, **stack[MAX_LIST_DEPTH];
- int (*callback)( imap_store_t *ctx, list_t *list, char *cmd );
- int level, need_bytes;
- } parse_list_state_t;
- typedef struct imap_cmd imap_cmd_t;
- struct imap_store {
- store_t gen;
- const char *label; /* foreign */
- const char *prefix;
- const char *name;
- uint ref_count;
- uint opts;
- enum { SST_BAD, SST_HALF, SST_GOOD } state;
- /* trash folder's existence is not confirmed yet */
- enum { TrashUnknown, TrashChecking, TrashKnown } trashnc;
- // What kind of BODY-less FETCH response we're expecting.
- enum { FetchNone, FetchMsgs, FetchUidNext } fetch_sts;
- uint got_namespace:1;
- uint has_forwarded:1;
- char delimiter[2]; /* hierarchy delimiter */
- char *ns_prefix, ns_delimiter; /* NAMESPACE info */
- string_list_t *boxes; // _list results
- char listed; // was _list already run with these flags?
- // note that the message counts do _not_ reflect stats from msgs,
- // but mailbox totals.
- int total_msgs, recent_msgs;
- uint uidvalidity, uidnext;
- message_t *msgs;
- message_t **msgapp; /* FETCH results */
- uint caps; /* CAPABILITY results */
- string_list_t *auth_mechs;
- parse_list_state_t parse_list_sts;
- /* command queue */
- imap_cmd_t *pending, **pending_append;
- imap_cmd_t *in_progress, **in_progress_append;
- imap_cmd_t *wait_check, **wait_check_append;
- int nexttag, num_in_progress, num_wait_check;
- uint buffer_mem; /* memory currently occupied by buffers in the queue */
- /* Used during sequential operations like connect */
- enum { GreetingPending = 0, GreetingBad, GreetingOk, GreetingPreauth } greeting;
- int expectBYE; /* LOGOUT is in progress */
- int expectEOF; /* received LOGOUT's OK or unsolicited BYE */
- int canceling; /* imap_cancel() is in progress */
- union {
- void (*imap_open)( int sts, void *aux );
- void (*imap_cancel)( void *aux );
- } callbacks;
- void *callback_aux;
- #ifdef HAVE_LIBSASL
- sasl_conn_t *sasl;
- int sasl_cont;
- #endif
- void (*bad_callback)( void *aux );
- void *bad_callback_aux;
- conn_t conn; /* this is BIG, so put it last */
- };
- struct imap_cmd {
- struct imap_cmd *next;
- char *cmd;
- int tag;
- struct {
- /* Will be called on each continuation request until it resets this pointer.
- * Needs to invoke bad_callback and return -1 on error, otherwise return 0. */
- int (*cont)( imap_store_t *ctx, imap_cmd_t *cmd, const char *prompt );
- void (*done)( imap_store_t *ctx, imap_cmd_t *cmd, int response );
- char *data;
- uint data_len;
- uint uid; /* to identify fetch responses */
- char high_prio; /* if command is queued, put it at the front of the queue. */
- char wait_check; // Don't report success until subsequent CHECK success.
- char to_trash; /* we are storing to trash, not current. */
- char create; /* create the mailbox if we get an error which suggests so. */
- char failok; /* Don't complain about NO response. */
- } param;
- };
- typedef struct {
- imap_cmd_t gen;
- void (*callback)( int sts, void *aux );
- void *callback_aux;
- } imap_cmd_simple_t;
- typedef struct {
- imap_cmd_simple_t gen;
- msg_data_t *msg_data;
- } imap_cmd_fetch_msg_t;
- typedef struct {
- imap_cmd_t gen;
- void (*callback)( int sts, uint uid, void *aux );
- void *callback_aux;
- uint out_uid;
- } imap_cmd_out_uid_t;
- typedef struct {
- imap_cmd_t gen;
- void (*callback)( int sts, message_t *msgs, void *aux );
- void *callback_aux;
- message_t **out_msgs;
- uint uid;
- } imap_cmd_find_new_t;
- typedef struct {
- uint ref_count;
- int ret_val;
- } imap_cmd_refcounted_state_t;
- typedef struct {
- imap_cmd_t gen;
- imap_cmd_refcounted_state_t *state;
- } imap_cmd_refcounted_t;
- #define CAP(cap) (ctx->caps & (1 << (cap)))
- enum CAPABILITY {
- NOLOGIN = 0,
- #ifdef HAVE_LIBSASL
- SASLIR,
- #endif
- #ifdef HAVE_LIBSSL
- STARTTLS,
- #endif
- UIDPLUS,
- LITERALPLUS,
- MOVE,
- NAMESPACE,
- COMPRESS_DEFLATE
- };
- static const char *cap_list[] = {
- "LOGINDISABLED",
- #ifdef HAVE_LIBSASL
- "SASL-IR",
- #endif
- #ifdef HAVE_LIBSSL
- "STARTTLS",
- #endif
- "UIDPLUS",
- "LITERAL+",
- "MOVE",
- "NAMESPACE",
- "COMPRESS=DEFLATE"
- };
- #define RESP_OK 0
- #define RESP_NO 1
- #define RESP_CANCEL 2
- static INLINE void imap_ref( imap_store_t *ctx ) { ++ctx->ref_count; }
- static int imap_deref( imap_store_t *ctx );
- static void imap_invoke_bad_callback( imap_store_t *ctx );
- /* Keep the mailbox driver flag definitions in sync: */
- /* grep for MAILBOX_DRIVER_FLAG */
- /* The order is according to alphabetical maildir flag sort */
- static const char *Flags[] = {
- "\\Draft", /* 'D' */
- "\\Flagged", /* 'F' */
- "$Forwarded", /* 'P' */
- "\\Answered", /* 'R' */
- "\\Seen", /* 'S' */
- "\\Deleted", /* 'T' */
- };
- static imap_cmd_t *
- new_imap_cmd( uint size )
- {
- imap_cmd_t *cmd = nfmalloc( size );
- memset( &cmd->param, 0, sizeof(cmd->param) );
- return cmd;
- }
- #define INIT_IMAP_CMD(type, cmdp, cb, aux) \
- cmdp = (type *)new_imap_cmd( sizeof(*cmdp) ); \
- cmdp->callback = cb; \
- cmdp->callback_aux = aux;
- #define INIT_IMAP_CMD_X(type, cmdp, cb, aux) \
- cmdp = (type *)new_imap_cmd( sizeof(*cmdp) ); \
- cmdp->gen.callback = cb; \
- cmdp->gen.callback_aux = aux;
- static void
- done_imap_cmd( imap_store_t *ctx, imap_cmd_t *cmd, int response )
- {
- if (cmd->param.wait_check)
- ctx->num_wait_check--;
- cmd->param.done( ctx, cmd, response );
- if (cmd->param.data) {
- free( cmd->param.data );
- ctx->buffer_mem -= cmd->param.data_len;
- }
- free( cmd->cmd );
- free( cmd );
- }
- static void
- send_imap_cmd( imap_store_t *ctx, imap_cmd_t *cmd )
- {
- int litplus, iovcnt = 1;
- int bufl;
- const char *buffmt;
- conn_iovec_t iov[3];
- char buf[4096];
- cmd->tag = ++ctx->nexttag;
- if (!cmd->param.data) {
- buffmt = "%d %s\r\n";
- litplus = 0;
- } else if ((cmd->param.to_trash && ctx->trashnc == TrashUnknown) || !CAP(LITERALPLUS) || cmd->param.data_len >= 100*1024) {
- buffmt = "%d %s{%d}\r\n";
- litplus = 0;
- } else {
- buffmt = "%d %s{%d+}\r\n";
- litplus = 1;
- }
- DIAG_PUSH
- DIAG_DISABLE("-Wformat-nonliteral")
- bufl = nfsnprintf( buf, sizeof(buf), buffmt,
- cmd->tag, cmd->cmd, cmd->param.data_len );
- DIAG_POP
- if (DFlags & DEBUG_NET) {
- if (ctx->num_in_progress)
- printf( "(%d in progress) ", ctx->num_in_progress );
- if (starts_with( cmd->cmd, -1, "LOGIN", 5 ))
- printf( "%s>>> %d LOGIN <user> <pass>\n", ctx->label, cmd->tag );
- else if (starts_with( cmd->cmd, -1, "AUTHENTICATE PLAIN", 18 ))
- printf( "%s>>> %d AUTHENTICATE PLAIN <authdata>\n", ctx->label, cmd->tag );
- else
- printf( "%s>>> %s", ctx->label, buf );
- fflush( stdout );
- }
- iov[0].buf = buf;
- iov[0].len = (uint)bufl;
- iov[0].takeOwn = KeepOwn;
- if (litplus) {
- if (DFlags & DEBUG_NET_ALL) {
- printf( "%s>>>>>>>>>\n", ctx->label );
- fwrite( cmd->param.data, cmd->param.data_len, 1, stdout );
- printf( "%s>>>>>>>>>\n", ctx->label );
- fflush( stdout );
- }
- iov[1].buf = cmd->param.data;
- iov[1].len = cmd->param.data_len;
- iov[1].takeOwn = GiveOwn;
- cmd->param.data = NULL;
- ctx->buffer_mem -= cmd->param.data_len;
- iov[2].buf = "\r\n";
- iov[2].len = 2;
- iov[2].takeOwn = KeepOwn;
- iovcnt = 3;
- }
- socket_write( &ctx->conn, iov, iovcnt );
- if (cmd->param.to_trash && ctx->trashnc == TrashUnknown)
- ctx->trashnc = TrashChecking;
- cmd->next = NULL;
- *ctx->in_progress_append = cmd;
- ctx->in_progress_append = &cmd->next;
- ctx->num_in_progress++;
- socket_expect_activity( &ctx->conn, 1 );
- }
- static int
- cmd_sendable( imap_store_t *ctx, imap_cmd_t *cmd )
- {
- if (ctx->conn.write_buf) {
- /* Don't build up a long queue in the socket, so we can
- * control when the commands are actually sent.
- * This allows reliable cancelation of pending commands,
- * injecting commands in front of other pending commands,
- * and keeping num_in_progress accurate. */
- return 0;
- }
- if (ctx->in_progress) {
- /* If the last command in flight ... */
- imap_cmd_t *cmdp = (imap_cmd_t *)((char *)ctx->in_progress_append -
- offsetof(imap_cmd_t, next));
- if (cmdp->param.cont || cmdp->param.data) {
- /* ... is expected to trigger a continuation request, we need to
- * wait for that round-trip before sending the next command. */
- return 0;
- }
- }
- if (cmd->param.to_trash && ctx->trashnc == TrashChecking) {
- /* Don't build a queue of MOVE/COPY/APPEND commands that may all fail. */
- return 0;
- }
- if (ctx->num_in_progress >= ((imap_store_conf_t *)ctx->gen.conf)->server->max_in_progress) {
- /* Too many commands in flight. */
- return 0;
- }
- return 1;
- }
- static void
- flush_imap_cmds( imap_store_t *ctx )
- {
- imap_cmd_t *cmd;
- if ((cmd = ctx->pending) && cmd_sendable( ctx, cmd )) {
- if (!(ctx->pending = cmd->next))
- ctx->pending_append = &ctx->pending;
- send_imap_cmd( ctx, cmd );
- }
- }
- static void
- finalize_checked_imap_cmds( imap_store_t *ctx, int resp )
- {
- imap_cmd_t *cmd;
- while ((cmd = ctx->wait_check)) {
- if (!(ctx->wait_check = cmd->next))
- ctx->wait_check_append = &ctx->wait_check;
- done_imap_cmd( ctx, cmd, resp );
- }
- }
- static void
- cancel_pending_imap_cmds( imap_store_t *ctx )
- {
- imap_cmd_t *cmd;
- while ((cmd = ctx->pending)) {
- if (!(ctx->pending = cmd->next))
- ctx->pending_append = &ctx->pending;
- done_imap_cmd( ctx, cmd, RESP_CANCEL );
- }
- }
- static void
- cancel_sent_imap_cmds( imap_store_t *ctx )
- {
- imap_cmd_t *cmd;
- socket_expect_activity( &ctx->conn, 0 );
- while ((cmd = ctx->in_progress)) {
- ctx->in_progress = cmd->next;
- /* don't update num_in_progress and in_progress_append - store is dead */
- done_imap_cmd( ctx, cmd, RESP_CANCEL );
- }
- }
- static void
- submit_imap_cmd( imap_store_t *ctx, imap_cmd_t *cmd )
- {
- assert( ctx );
- assert( ctx->bad_callback );
- assert( cmd );
- assert( cmd->param.done );
- if (cmd->param.wait_check)
- ctx->num_wait_check++;
- if ((ctx->pending && !cmd->param.high_prio) || !cmd_sendable( ctx, cmd )) {
- if (ctx->pending && cmd->param.high_prio) {
- cmd->next = ctx->pending;
- ctx->pending = cmd;
- } else {
- cmd->next = NULL;
- *ctx->pending_append = cmd;
- ctx->pending_append = &cmd->next;
- }
- } else {
- send_imap_cmd( ctx, cmd );
- }
- }
- /* Minimal printf() replacement that supports an %\s format sequence to print backslash-escaped
- * string literals. Note that this does not automatically add quotes around the printed string,
- * so it is possible to concatenate multiple segments. */
- static char *
- imap_vprintf( const char *fmt, va_list ap )
- {
- const char *s;
- char *d, *ed;
- char c;
- char buf[4096];
- d = buf;
- ed = d + sizeof(buf);
- s = fmt;
- for (;;) {
- c = *fmt;
- if (!c || c == '%') {
- uint l = fmt - s;
- if (d + l > ed)
- oob();
- memcpy( d, s, l );
- d += l;
- if (!c)
- return nfstrndup( buf, (size_t)(d - buf) );
- uint maxlen = UINT_MAX;
- c = *++fmt;
- if (c == '\\') {
- c = *++fmt;
- if (c != 's') {
- fputs( "Fatal: unsupported escaped format specifier. Please report a bug.\n", stderr );
- abort();
- }
- s = va_arg( ap, const char * );
- while ((c = *s++)) {
- if (d + 2 > ed)
- oob();
- if (c == '\\' || c == '"')
- *d++ = '\\';
- *d++ = c;
- }
- } else { /* \\ cannot be combined with anything else. */
- if (c == '.') {
- c = *++fmt;
- if (c != '*') {
- fputs( "Fatal: unsupported string length specification. Please report a bug.\n", stderr );
- abort();
- }
- maxlen = va_arg( ap, uint );
- c = *++fmt;
- }
- if (c == 'c') {
- if (d + 1 > ed)
- oob();
- *d++ = (char)va_arg( ap , int );
- } else if (c == 's') {
- s = va_arg( ap, const char * );
- l = strnlen( s, maxlen );
- if (d + l > ed)
- oob();
- memcpy( d, s, l );
- d += l;
- } else if (c == 'd') {
- d += nfsnprintf( d, ed - d, "%d", va_arg( ap , int ) );
- } else if (c == 'u') {
- d += nfsnprintf( d, ed - d, "%u", va_arg( ap , uint ) );
- } else {
- fputs( "Fatal: unsupported format specifier. Please report a bug.\n", stderr );
- abort();
- }
- }
- s = ++fmt;
- } else {
- fmt++;
- }
- }
- }
- static void
- imap_exec( imap_store_t *ctx, imap_cmd_t *cmdp,
- void (*done)( imap_store_t *ctx, imap_cmd_t *cmd, int response ),
- const char *fmt, ... )
- {
- va_list ap;
- if (!cmdp)
- cmdp = new_imap_cmd( sizeof(*cmdp) );
- cmdp->param.done = done;
- va_start( ap, fmt );
- cmdp->cmd = imap_vprintf( fmt, ap );
- va_end( ap );
- submit_imap_cmd( ctx, cmdp );
- }
- static void
- transform_box_response( int *response )
- {
- switch (*response) {
- case RESP_CANCEL: *response = DRV_CANCELED; break;
- case RESP_NO: *response = DRV_BOX_BAD; break;
- default: *response = DRV_OK; break;
- }
- }
- static void
- imap_done_simple_box( imap_store_t *ctx ATTR_UNUSED,
- imap_cmd_t *cmd, int response )
- {
- imap_cmd_simple_t *cmdp = (imap_cmd_simple_t *)cmd;
- transform_box_response( &response );
- cmdp->callback( response, cmdp->callback_aux );
- }
- static void
- transform_msg_response( int *response )
- {
- switch (*response) {
- case RESP_CANCEL: *response = DRV_CANCELED; break;
- case RESP_NO: *response = DRV_MSG_BAD; break;
- default: *response = DRV_OK; break;
- }
- }
- static void
- imap_done_simple_msg( imap_store_t *ctx ATTR_UNUSED,
- imap_cmd_t *cmd, int response )
- {
- imap_cmd_simple_t *cmdp = (imap_cmd_simple_t *)cmd;
- transform_msg_response( &response );
- cmdp->callback( response, cmdp->callback_aux );
- }
- static imap_cmd_refcounted_state_t *
- imap_refcounted_new_state( uint sz )
- {
- imap_cmd_refcounted_state_t *sts = nfmalloc( sz );
- sts->ref_count = 1; /* so forced sync does not cause an early exit */
- sts->ret_val = DRV_OK;
- return sts;
- }
- #define INIT_REFCOUNTED_STATE(type, sts, cb, aux) \
- type *sts = (type *)imap_refcounted_new_state( sizeof(type) ); \
- sts->callback = cb; \
- sts->callback_aux = aux;
- static imap_cmd_t *
- imap_refcounted_new_cmd( imap_cmd_refcounted_state_t *sts )
- {
- imap_cmd_refcounted_t *cmd = (imap_cmd_refcounted_t *)new_imap_cmd( sizeof(*cmd) );
- cmd->state = sts;
- sts->ref_count++;
- return &cmd->gen;
- }
- #define DONE_REFCOUNTED_STATE(sts) \
- if (!--sts->gen.ref_count) { \
- sts->callback( sts->gen.ret_val, sts->callback_aux ); \
- free( sts ); \
- }
- #define DONE_REFCOUNTED_STATE_ARGS(sts, finalize, ...) \
- if (!--sts->gen.ref_count) { \
- finalize \
- sts->callback( sts->gen.ret_val, __VA_ARGS__, sts->callback_aux ); \
- free( sts ); \
- }
- static void
- transform_refcounted_box_response( imap_cmd_refcounted_state_t *sts, int response )
- {
- switch (response) {
- case RESP_CANCEL:
- sts->ret_val = DRV_CANCELED;
- break;
- case RESP_NO:
- if (sts->ret_val == DRV_OK) /* Don't override cancelation. */
- sts->ret_val = DRV_BOX_BAD;
- break;
- }
- }
- static void
- transform_refcounted_msg_response( imap_cmd_refcounted_state_t *sts, int response )
- {
- switch (response) {
- case RESP_CANCEL:
- sts->ret_val = DRV_CANCELED;
- break;
- case RESP_NO:
- if (sts->ret_val == DRV_OK) /* Don't override cancelation. */
- sts->ret_val = DRV_MSG_BAD;
- break;
- }
- }
- static const char *
- imap_strchr( const char *s, char tc )
- {
- for (;; s++) {
- char c = *s;
- if (c == '\\')
- c = *++s;
- if (!c)
- return NULL;
- if (c == tc)
- return s;
- }
- }
- static char *
- next_arg( char **ps )
- {
- char *ret, *s, *d;
- char c;
- assert( ps );
- s = *ps;
- if (!s)
- return NULL;
- while (isspace( (uchar)*s ))
- s++;
- if (!*s) {
- *ps = NULL;
- return NULL;
- }
- if (*s == '"') {
- s++;
- ret = d = s;
- while ((c = *s++) != '"') {
- if (c == '\\')
- c = *s++;
- if (!c) {
- *ps = NULL;
- return NULL;
- }
- *d++ = c;
- }
- *d = 0;
- } else {
- ret = s;
- while ((c = *s)) {
- if (isspace( (uchar)c )) {
- *s++ = 0;
- break;
- }
- s++;
- }
- }
- if (!*s)
- s = NULL;
- *ps = s;
- return ret;
- }
- static int
- is_opt_atom( list_t *list )
- {
- return list && list->val && list->val != LIST;
- }
- static int
- is_atom( list_t *list )
- {
- return list && list->val && list->val != NIL && list->val != LIST;
- }
- static int
- is_list( list_t *list )
- {
- return list && list->val == LIST;
- }
- static void
- free_list( list_t *list )
- {
- list_t *tmp;
- for (; list; list = tmp) {
- tmp = list->next;
- if (is_list( list ))
- free_list( list->child );
- else if (is_atom( list ))
- free( list->val );
- free( list );
- }
- }
- enum {
- LIST_OK,
- LIST_PARTIAL,
- LIST_BAD
- };
- static int
- parse_imap_list( imap_store_t *ctx, char **sp, parse_list_state_t *sts )
- {
- list_t *cur, **curp;
- char *s = *sp, *d, *p;
- int n, bytes;
- char c;
- assert( sts );
- assert( sts->level > 0 );
- curp = sts->stack[--sts->level];
- bytes = sts->need_bytes;
- if (bytes >= 0) {
- sts->need_bytes = -1;
- if (!bytes)
- goto getline;
- cur = (list_t *)((char *)curp - offsetof(list_t, next));
- s = cur->val + cur->len - bytes;
- goto getbytes;
- }
- if (!s)
- return LIST_BAD;
- for (;;) {
- while (isspace( (uchar)*s ))
- s++;
- if (sts->level && *s == ')') {
- s++;
- curp = sts->stack[--sts->level];
- goto next;
- }
- *curp = cur = nfmalloc( sizeof(*cur) );
- cur->val = NULL; /* for clean bail */
- curp = &cur->next;
- *curp = NULL; /* ditto */
- if (*s == '(') {
- /* sublist */
- if (sts->level == MAX_LIST_DEPTH)
- goto bail;
- s++;
- cur->val = LIST;
- sts->stack[sts->level++] = curp;
- curp = &cur->child;
- *curp = NULL; /* for clean bail */
- goto next2;
- } else if (ctx && *s == '{') {
- /* literal */
- bytes = (int)(cur->len = strtoul( s + 1, &s, 10 ));
- if (*s != '}' || *++s)
- goto bail;
- s = cur->val = nfmalloc( cur->len + 1 );
- s[cur->len] = 0;
- getbytes:
- n = socket_read( &ctx->conn, s, (uint)bytes );
- if (n < 0) {
- badeof:
- error( "IMAP error: unexpected EOF from %s\n", ctx->conn.name );
- goto bail;
- }
- bytes -= n;
- if (bytes > 0)
- goto postpone;
- if (DFlags & DEBUG_NET_ALL) {
- printf( "%s=========\n", ctx->label );
- fwrite( cur->val, cur->len, 1, stdout );
- printf( "%s=========\n", ctx->label );
- fflush( stdout );
- }
- getline:
- if (!(s = socket_read_line( &ctx->conn )))
- goto postpone;
- if (s == (void *)~0)
- goto badeof;
- if (DFlags & DEBUG_NET) {
- printf( "%s%s\n", ctx->label, s );
- fflush( stdout );
- }
- } else if (*s == '"') {
- /* quoted string */
- s++;
- p = d = s;
- while ((c = *s++) != '"') {
- if (c == '\\')
- c = *s++;
- if (!c)
- goto bail;
- *d++ = c;
- }
- cur->len = (uint)(d - p);
- cur->val = nfstrndup( p, cur->len );
- } else {
- /* atom */
- p = s;
- for (; *s && !isspace( (uchar)*s ); s++)
- if (sts->level && *s == ')')
- break;
- cur->len = (uint)(s - p);
- if (equals( p, (int)cur->len, "NIL", 3 ))
- cur->val = NIL;
- else
- cur->val = nfstrndup( p, cur->len );
- }
- next:
- if (!sts->level)
- break;
- next2:
- if (!*s)
- goto bail;
- }
- *sp = s;
- return LIST_OK;
- postpone:
- if (sts->level < MAX_LIST_DEPTH) {
- sts->stack[sts->level++] = curp;
- sts->need_bytes = bytes;
- return LIST_PARTIAL;
- }
- bail:
- free_list( sts->head );
- return LIST_BAD;
- }
- static void
- parse_list_init( parse_list_state_t *sts )
- {
- sts->need_bytes = -1;
- sts->level = 1;
- sts->head = NULL;
- sts->stack[0] = &sts->head;
- }
- static int
- parse_list_continue( imap_store_t *ctx, char *s )
- {
- list_t *list;
- int resp;
- if ((resp = parse_imap_list( ctx, &s, &ctx->parse_list_sts )) != LIST_PARTIAL) {
- list = (resp == LIST_BAD) ? NULL : ctx->parse_list_sts.head;
- ctx->parse_list_sts.head = NULL;
- resp = ctx->parse_list_sts.callback( ctx, list, s );
- free_list( list );
- }
- return resp;
- }
- static int
- parse_list( imap_store_t *ctx, char *s, int (*cb)( imap_store_t *ctx, list_t *list, char *s ) )
- {
- parse_list_init( &ctx->parse_list_sts );
- ctx->parse_list_sts.callback = cb;
- return parse_list_continue( ctx, s );
- }
- static int parse_namespace_rsp_p2( imap_store_t *, list_t *, char * );
- static int parse_namespace_rsp_p3( imap_store_t *, list_t *, char * );
- static int
- parse_namespace_rsp( imap_store_t *ctx, list_t *list, char *s )
- {
- // We use only the 1st personal namespace. Making this configurable
- // would not add value over just specifying Path.
- if (!list) {
- bad:
- error( "IMAP error: malformed NAMESPACE response\n" );
- return LIST_BAD;
- }
- if (list->val != NIL) {
- if (list->val != LIST)
- goto bad;
- list_t *nsp_1st = list->child;
- if (nsp_1st->val != LIST)
- goto bad;
- list_t *nsp_1st_ns = nsp_1st->child;
- if (!is_atom( nsp_1st_ns ))
- goto bad;
- ctx->ns_prefix = nsp_1st_ns->val;
- nsp_1st_ns->val = NULL;
- list_t *nsp_1st_dl = nsp_1st_ns->next;
- if (!is_opt_atom( nsp_1st_dl ))
- goto bad;
- if (is_atom( nsp_1st_dl ))
- ctx->ns_delimiter = nsp_1st_dl->val[0];
- // Namespace response extensions may follow here; we don't care.
- }
- return parse_list( ctx, s, parse_namespace_rsp_p2 );
- }
- static int
- parse_namespace_rsp_p2( imap_store_t *ctx, list_t *list ATTR_UNUSED, char *s )
- {
- return parse_list( ctx, s, parse_namespace_rsp_p3 );
- }
- static int
- parse_namespace_rsp_p3( imap_store_t *ctx ATTR_UNUSED, list_t *list ATTR_UNUSED, char *s ATTR_UNUSED )
- {
- return LIST_OK;
- }
- static time_t
- parse_date( const char *str )
- {
- char *end;
- time_t date;
- int hours, mins;
- struct tm datetime;
- memset( &datetime, 0, sizeof(datetime) );
- if (!(end = strptime( str, "%e-%b-%Y %H:%M:%S ", &datetime )))
- return -1;
- if ((date = timegm( &datetime )) == -1)
- return -1;
- if (sscanf( end, "%3d%2d", &hours, &mins ) != 2)
- return -1;
- return date - (hours * 60 + mins) * 60;
- }
- static int
- parse_fetched_flags( list_t *list, uchar *flags, uchar *status )
- {
- for (; list; list = list->next) {
- if (!is_atom( list )) {
- error( "IMAP error: unable to parse FLAGS list\n" );
- return 0;
- }
- if (list->val[0] != '\\' && list->val[0] != '$')
- continue;
- if (!strcmp( "\\Recent", list->val )) {
- *status |= M_RECENT;
- goto flagok;
- }
- for (uint i = 0; i < as(Flags); i++) {
- if (!strcmp( Flags[i], list->val )) {
- *flags |= 1 << i;
- goto flagok;
- }
- }
- if (list->val[0] == '$')
- goto flagok; // Ignore unknown user-defined flags (keywords)
- if (list->val[1] == 'X' && list->val[2] == '-')
- goto flagok; // Ignore system flag extensions
- warn( "IMAP warning: unknown system flag %s\n", list->val );
- flagok: ;
- }
- return 1;
- }
- static void
- parse_fetched_header( char *val, uint uid, char **tuid, char **msgid, uint *msgid_len )
- {
- char *end;
- int off, in_msgid = 0;
- for (; (end = strchr( val, '\n' )); val = end + 1) {
- int len = (int)(end - val);
- if (len && end[-1] == '\r')
- len--;
- if (!len)
- break;
- if (starts_with_upper( val, len, "X-TUID: ", 8 )) {
- if (len < 8 + TUIDL) {
- warn( "IMAP warning: malformed X-TUID header (UID %u)\n", uid );
- continue;
- }
- *tuid = val + 8;
- in_msgid = 0;
- continue;
- }
- if (starts_with_upper( val, len, "MESSAGE-ID:", 11 )) {
- off = 11;
- } else if (in_msgid) {
- if (!isspace( val[0] )) {
- in_msgid = 0;
- continue;
- }
- off = 1;
- } else {
- continue;
- }
- while (off < len && isspace( val[off] ))
- off++;
- if (off == len) {
- in_msgid = 1;
- continue;
- }
- *msgid = val + off;
- *msgid_len = (uint)(len - off);
- in_msgid = 0;
- }
- }
- static int
- parse_fetch_rsp( imap_store_t *ctx, list_t *list, char *s ATTR_UNUSED )
- {
- list_t *body = NULL, *tmp;
- char *tuid = NULL, *msgid = NULL, *ep;
- imap_message_t *cur;
- msg_data_t *msgdata;
- imap_cmd_t *cmdp;
- uchar mask = 0, status = 0;
- uint uid = 0, size = 0, msgid_len = 0;
- time_t date = 0;
- if (!is_list( list )) {
- error( "IMAP error: bogus FETCH response\n" );
- return LIST_BAD;
- }
- for (tmp = list->child; tmp; tmp = tmp->next) {
- if (!is_atom( tmp )) {
- error( "IMAP error: bogus item name in FETCH response\n" );
- return LIST_BAD;
- }
- const char *name = tmp->val;
- tmp = tmp->next;
- if (!strcmp( "UID", name )) {
- if (!is_atom( tmp ) || (uid = strtoul( tmp->val, &ep, 10 ), *ep)) {
- error( "IMAP error: unable to parse UID\n" );
- return LIST_BAD;
- }
- } else if (!strcmp( "FLAGS", name )) {
- if (!is_list( tmp )) {
- error( "IMAP error: unable to parse FLAGS\n" );
- return LIST_BAD;
- }
- if (!parse_fetched_flags( tmp->child, &mask, &status ))
- return LIST_BAD;
- status |= M_FLAGS;
- } else if (!strcmp( "INTERNALDATE", name )) {
- if (!is_atom( tmp )) {
- error( "IMAP error: unable to parse INTERNALDATE\n" );
- return LIST_BAD;
- }
- if ((date = parse_date( tmp->val )) == -1) {
- error( "IMAP error: unable to parse INTERNALDATE format\n" );
- return LIST_BAD;
- }
- status |= M_DATE;
- } else if (!strcmp( "RFC822.SIZE", name )) {
- if (!is_atom( tmp ) || (size = strtoul( tmp->val, &ep, 10 ), *ep)) {
- error( "IMAP error: unable to parse RFC822.SIZE\n" );
- return LIST_BAD;
- }
- status |= M_SIZE;
- } else if (!strcmp( "BODY[]", name ) || !strcmp( "BODY[HEADER]", name )) {
- if (!is_atom( tmp )) {
- error( "IMAP error: unable to parse BODY[]\n" );
- return LIST_BAD;
- }
- body = tmp;
- status |= M_BODY;
- } else if (!strcmp( "BODY[HEADER.FIELDS", name )) {
- if (!is_list( tmp )) {
- bfail:
- error( "IMAP error: unable to parse BODY[HEADER.FIELDS ...]\n" );
- return LIST_BAD;
- }
- tmp = tmp->next;
- if (!is_atom( tmp ) || strcmp( tmp->val, "]" ))
- goto bfail;
- tmp = tmp->next;
- if (!is_atom( tmp ))
- goto bfail;
- parse_fetched_header( tmp->val, uid, &tuid, &msgid, &msgid_len );
- status |= M_HEADER;
- }
- }
- if (!uid) {
- // Ignore async flag updates for now.
- status &= ~(M_FLAGS | M_RECENT);
- } else if (status & M_BODY) {
- for (cmdp = ctx->in_progress; cmdp; cmdp = cmdp->next)
- if (cmdp->param.uid == uid)
- goto gotuid;
- goto badrsp;
- gotuid:
- msgdata = ((imap_cmd_fetch_msg_t *)cmdp)->msg_data;
- msgdata->data = body->val;
- body->val = NULL; // Don't free together with list.
- msgdata->len = body->len;
- msgdata->date = date;
- if (status & M_FLAGS)
- msgdata->flags = mask;
- status &= ~(M_FLAGS | M_RECENT | M_BODY | M_DATE);
- } else if (ctx->fetch_sts == FetchUidNext) {
- // Workaround for server not sending UIDNEXT and/or APPENDUID.
- ctx->uidnext = uid + 1;
- } else if (ctx->fetch_sts == FetchMsgs) {
- cur = nfcalloc( sizeof(*cur) );
- *ctx->msgapp = &cur->gen;
- ctx->msgapp = &cur->gen.next;
- cur->gen.uid = uid;
- cur->gen.flags = mask;
- cur->gen.status = status;
- cur->gen.size = size;
- if (msgid)
- cur->gen.msgid = nfstrndup( msgid, msgid_len );
- if (tuid)
- memcpy( cur->gen.tuid, tuid, TUIDL );
- status &= ~(M_FLAGS | M_RECENT | M_SIZE | M_HEADER);
- } else {
- badrsp:
- error( "IMAP error: unexpected FETCH response (UID %u)\n", uid );
- return LIST_BAD;
- }
- if (status) {
- error( "IMAP error: received extraneous data in FETCH response\n" );
- return LIST_BAD;
- }
- return LIST_OK;
- }
- static void
- parse_capability( imap_store_t *ctx, char *cmd )
- {
- char *arg;
- uint i;
- free_string_list( ctx->auth_mechs );
- ctx->auth_mechs = NULL;
- ctx->caps = 0x80000000;
- while ((arg = next_arg( &cmd ))) {
- if (starts_with( arg, -1, "AUTH=", 5 )) {
- add_string_list( &ctx->auth_mechs, arg + 5 );
- } else {
- for (i = 0; i < as(cap_list); i++)
- if (!strcmp( cap_list[i], arg ))
- ctx->caps |= 1 << i;
- }
- }
- ctx->caps &= ~((imap_store_conf_t *)ctx->gen.conf)->server->cap_mask;
- if (!CAP(NOLOGIN))
- add_string_list( &ctx->auth_mechs, "LOGIN" );
- }
- static int
- parse_response_code( imap_store_t *ctx, imap_cmd_t *cmd, char *s )
- {
- char *arg, *earg, *p;
- if (!s || *s != '[')
- return RESP_OK; /* no response code */
- s++;
- if (!(p = strchr( s, ']' ))) {
- bad_resp:
- error( "IMAP error: malformed response code\n" );
- return RESP_CANCEL;
- }
- *p++ = 0;
- if (!(arg = next_arg( &s )))
- goto bad_resp;
- if (!strcmp( "UIDVALIDITY", arg )) {
- if (!(arg = next_arg( &s )) ||
- (ctx->uidvalidity = strtoul( arg, &earg, 10 ), *earg))
- {
- error( "IMAP error: malformed UIDVALIDITY status\n" );
- return RESP_CANCEL;
- }
- } else if (!strcmp( "UIDNEXT", arg )) {
- if (!(arg = next_arg( &s )) ||
- (ctx->uidnext = strtoul( arg, &earg, 10 ), *earg))
- {
- error( "IMAP error: malformed UIDNEXT status\n" );
- return RESP_CANCEL;
- }
- } else if (!strcmp( "CAPABILITY", arg )) {
- parse_capability( ctx, s );
- } else if (!strcmp( "ALERT", arg )) {
- /* RFC2060 says that these messages MUST be displayed
- * to the user
- */
- for (; isspace( (uchar)*p ); p++);
- error( "*** IMAP ALERT *** %s\n", p );
- } else if (cmd && !strcmp( "APPENDUID", arg )) {
- if (!(arg = next_arg( &s )) ||
- (ctx->uidvalidity = strtoul( arg, &earg, 10 ), *earg) ||
- !(arg = next_arg( &s )) ||
- (((imap_cmd_out_uid_t *)cmd)->out_uid = strtoul( arg, &earg, 10 ), *earg))
- {
- error( "IMAP error: malformed APPENDUID status\n" );
- return RESP_CANCEL;
- }
- } else if (!strcmp( "PERMANENTFLAGS", arg )) {
- parse_list_init( &ctx->parse_list_sts );
- if (parse_imap_list( NULL, &s, &ctx->parse_list_sts ) != LIST_OK) {
- error( "IMAP error: malformed PERMANENTFLAGS status\n" );
- return RESP_CANCEL;
- }
- int ret = RESP_OK;
- for (list_t *tmp = ctx->parse_list_sts.head->child; tmp; tmp = tmp->next) {
- if (!is_atom( tmp )) {
- error( "IMAP error: malformed PERMANENTFLAGS status item\n" );
- ret = RESP_CANCEL;
- break;
- }
- if (!strcmp( tmp->val, "\\*" ) || !strcmp( tmp->val, "$Forwarded" )) {
- ctx->has_forwarded = 1;
- break;
- }
- }
- free_list( ctx->parse_list_sts.head );
- ctx->parse_list_sts.head = NULL;
- return ret;
- }
- return RESP_OK;
- }
- static int parse_list_rsp_p1( imap_store_t *, list_t *, char * );
- static int parse_list_rsp_p2( imap_store_t *, list_t *, char * );
- static int
- parse_list_rsp( imap_store_t *ctx, list_t *list, char *cmd )
- {
- list_t *lp;
- if (!is_list( list )) {
- error( "IMAP error: malformed LIST response\n" );
- return LIST_BAD;
- }
- for (lp = list->child; lp; lp = lp->next)
- if (is_atom( lp ) && !strcasecmp( lp->val, "\\NoSelect" ))
- return LIST_OK;
- return parse_list( ctx, cmd, parse_list_rsp_p1 );
- }
- static int
- parse_list_rsp_p1( imap_store_t *ctx, list_t *list, char *cmd ATTR_UNUSED )
- {
- if (!is_opt_atom( list )) {
- error( "IMAP error: malformed LIST response\n" );
- return LIST_BAD;
- }
- if (!ctx->delimiter[0] && is_atom( list ))
- ctx->delimiter[0] = list->val[0];
- return parse_list( ctx, cmd, parse_list_rsp_p2 );
- }
- // Use this to check whether a full path refers to the actual IMAP INBOX.
- static int
- is_inbox( imap_store_t *ctx, const char *arg, int argl )
- {
- if (!starts_with_upper( arg, argl, "INBOX", 5 ))
- return 0;
- if (arg[5] && arg[5] != ctx->delimiter[0])
- return 0;
- return 1;
- }
- // Use this to check whether a path fragment collides with the canonical INBOX.
- static int
- is_INBOX( imap_store_t *ctx, const char *arg, int argl )
- {
- if (!starts_with( arg, argl, "INBOX", 5 ))
- return 0;
- if (arg[5] && arg[5] != ctx->delimiter[0])
- return 0;
- return 1;
- }
- static int
- parse_list_rsp_p2( imap_store_t *ctx, list_t *list, char *cmd ATTR_UNUSED )
- {
- string_list_t *narg;
- char *arg;
- int argl;
- uint l;
- if (!is_atom( list )) {
- error( "IMAP error: malformed LIST response\n" );
- return LIST_BAD;
- }
- arg = list->val;
- argl = (int)list->len;
- if (is_inbox( ctx, arg, argl )) {
- // The server might be weird and have a non-uppercase INBOX. It
- // may legitimately do so, but we need the canonical spelling.
- memcpy( arg, "INBOX", 5 );
- } else if ((l = strlen( ctx->prefix ))) {
- if (!starts_with( arg, argl, ctx->prefix, l ))
- return LIST_OK;
- arg += l;
- argl -= l;
- // A folder named "INBOX" would be indistinguishable from the
- // actual INBOX after prefix stripping, so drop it. This applies
- // only to the fully uppercased spelling, as our canonical box
- // names are case-sensitive (unlike IMAP's INBOX).
- if (is_INBOX( ctx, arg, argl )) {
- if (!arg[5]) // No need to complain about subfolders as well.
- warn( "IMAP warning: ignoring INBOX in %s\n", ctx->prefix );
- return LIST_OK;
- }
- }
- if (argl >= 5 && !memcmp( arg + argl - 5, ".lock", 5 )) /* workaround broken servers */
- return LIST_OK;
- if (map_name( arg, (char **)&narg, offsetof(string_list_t, string), ctx->delimiter, "/") < 0) {
- warn( "IMAP warning: ignoring mailbox %s (reserved character '/' in name)\n", arg );
- return LIST_OK;
- }
- narg->next = ctx->boxes;
- ctx->boxes = narg;
- return LIST_OK;
- }
- static int
- prepare_name( char **buf, const imap_store_t *ctx, const char *prefix, const char *name )
- {
- uint pl = strlen( prefix );
- switch (map_name( name, buf, pl, "/", ctx->delimiter )) {
- case -1:
- error( "IMAP error: mailbox name %s contains server's hierarchy delimiter\n", name );
- return -1;
- case -2:
- error( "IMAP error: server's hierarchy delimiter not known\n" );
- return -1;
- default:
- memcpy( *buf, prefix, pl );
- return 0;
- }
- }
- static int
- prepare_box( char **buf, const imap_store_t *ctx )
- {
- const char *name = ctx->name;
- const char *pfx = ctx->prefix;
- if (starts_with_upper( name, -1, "INBOX", 5 ) && (!name[5] || name[5] == '/')) {
- if (!memcmp( name, "INBOX", 5 )) {
- pfx = "";
- } else if (!*pfx) {
- error( "IMAP error: cannot use unqualified '%s'. Did you mean INBOX?", name );
- return -1;
- }
- }
- return prepare_name( buf, ctx, pfx, name );
- }
- static int
- prepare_trash( char **buf, const imap_store_t *ctx )
- {
- return prepare_name( buf, ctx, ctx->prefix, ctx->gen.conf->trash );
- }
- typedef struct {
- imap_cmd_t gen;
- imap_cmd_t *orig_cmd;
- } imap_cmd_trycreate_t;
- static void imap_open_store_greeted( imap_store_t * );
- static void get_cmd_result_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_socket_read( void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)aux;
- imap_cmd_t *cmdp, **pcmdp;
- char *cmd, *arg, *arg1, *p;
- int resp, resp2, tag;
- conn_iovec_t iov[2];
- for (;;) {
- if (ctx->parse_list_sts.level) {
- resp = parse_list_continue( ctx, NULL );
- listret:
- if (resp == LIST_PARTIAL)
- return;
- if (resp == LIST_BAD)
- break;
- continue;
- }
- if (!(cmd = socket_read_line( &ctx->conn )))
- return;
- if (cmd == (void *)~0) {
- if (!ctx->expectEOF)
- error( "IMAP error: unexpected EOF from %s\n", ctx->conn.name );
- /* A clean shutdown sequence ends with bad_callback as well (see imap_cleanup()). */
- break;
- }
- if (DFlags & DEBUG_NET) {
- printf( "%s%s\n", ctx->label, cmd );
- fflush( stdout );
- }
- arg = next_arg( &cmd );
- if (!arg) {
- error( "IMAP error: empty response\n" );
- break;
- }
- if (*arg == '*') {
- arg = next_arg( &cmd );
- if (!arg) {
- error( "IMAP error: malformed untagged response\n" );
- break;
- }
- if (ctx->greeting == GreetingPending && !strcmp( "PREAUTH", arg )) {
- parse_response_code( ctx, NULL, cmd );
- ctx->greeting = GreetingPreauth;
- dogreet:
- imap_ref( ctx );
- imap_open_store_greeted( ctx );
- if (imap_deref( ctx ))
- return;
- } else if (!strcmp( "OK", arg )) {
- parse_response_code( ctx, NULL, cmd );
- if (ctx->greeting == GreetingPending) {
- ctx->greeting = GreetingOk;
- goto dogreet;
- }
- } else if (!strcmp( "BYE", arg )) {
- if (!ctx->expectBYE) {
- ctx->greeting = GreetingBad;
- error( "IMAP error: unexpected BYE response: %s\n", cmd );
- /* We just wait for the server to close the connection now. */
- ctx->expectEOF = 1;
- } else {
- /* We still need to wait for the LOGOUT's tagged OK. */
- }
- } else if (ctx->greeting == GreetingPending) {
- error( "IMAP error: bogus greeting response %s\n", arg );
- break;
- } else if (!strcmp( "NO", arg )) {
- warn( "Warning from IMAP server: %s\n", cmd );
- } else if (!strcmp( "BAD", arg )) {
- error( "Error from IMAP server: %s\n", cmd );
- } else if (!strcmp( "CAPABILITY", arg )) {
- parse_capability( ctx, cmd );
- } else if (!strcmp( "LIST", arg ) || !strcmp( "LSUB", arg )) {
- resp = parse_list( ctx, cmd, parse_list_rsp );
- goto listret;
- } else if (!strcmp( "NAMESPACE", arg )) {
- resp = parse_list( ctx, cmd, parse_namespace_rsp );
- goto listret;
- } else if ((arg1 = next_arg( &cmd ))) {
- if (!strcmp( "EXISTS", arg1 ))
- ctx->total_msgs = atoi( arg );
- else if (!strcmp( "EXPUNGE", arg1 ))
- ctx->total_msgs--;
- else if (!strcmp( "RECENT", arg1 ))
- ctx->recent_msgs = atoi( arg );
- else if(!strcmp ( "FETCH", arg1 )) {
- resp = parse_list( ctx, cmd, parse_fetch_rsp );
- goto listret;
- }
- } else {
- error( "IMAP error: unrecognized untagged response '%s'\n", arg );
- break; /* this may mean anything, so prefer not to spam the log */
- }
- continue;
- } else if (!ctx->in_progress) {
- error( "IMAP error: unexpected reply: %s %s\n", arg, cmd ? cmd : "" );
- break; /* this may mean anything, so prefer not to spam the log */
- } else if (*arg == '+') {
- socket_expect_activity( &ctx->conn, 0 );
- /* There can be any number of commands in flight, but only the last
- * one can require a continuation, as it enforces a round-trip. */
- cmdp = (imap_cmd_t *)((char *)ctx->in_progress_append -
- offsetof(imap_cmd_t, next));
- if (cmdp->param.data) {
- if (cmdp->param.to_trash)
- ctx->trashnc = TrashKnown; /* Can't get NO [TRYCREATE] any more. */
- if (DFlags & DEBUG_NET_ALL) {
- printf( "%s>>>>>>>>>\n", ctx->label );
- fwrite( cmdp->param.data, cmdp->param.data_len, 1, stdout );
- printf( "%s>>>>>>>>>\n", ctx->label );
- fflush( stdout );
- }
- iov[0].buf = cmdp->param.data;
- iov[0].len = cmdp->param.data_len;
- iov[0].takeOwn = GiveOwn;
- cmdp->param.data = NULL;
- ctx->buffer_mem -= cmdp->param.data_len;
- iov[1].buf = "\r\n";
- iov[1].len = 2;
- iov[1].takeOwn = KeepOwn;
- socket_write( &ctx->conn, iov, 2 );
- } else if (cmdp->param.cont) {
- if (cmdp->param.cont( ctx, cmdp, cmd ))
- return;
- } else {
- error( "IMAP error: unexpected command continuation request\n" );
- break;
- }
- socket_expect_activity( &ctx->conn, 1 );
- } else {
- tag = atoi( arg );
- for (pcmdp = &ctx->in_progress; (cmdp = *pcmdp); pcmdp = &cmdp->next)
- if (cmdp->tag == tag)
- goto gottag;
- error( "IMAP error: unexpected tag %s\n", arg );
- break;
- gottag:
- if (!(*pcmdp = cmdp->next))
- ctx->in_progress_append = pcmdp;
- if (!--ctx->num_in_progress)
- socket_expect_activity( &ctx->conn, 0 );
- arg = next_arg( &cmd );
- if (!arg) {
- error( "IMAP error: malformed tagged response\n" );
- break;
- }
- if (!strcmp( "OK", arg )) {
- if (cmdp->param.to_trash)
- ctx->trashnc = TrashKnown; /* Can't get NO [TRYCREATE] any more. */
- resp = RESP_OK;
- } else {
- if (!strcmp( "NO", arg )) {
- if (cmdp->param.create && cmd && starts_with( cmd, -1, "[TRYCREATE]", 11 )) { /* APPEND or UID COPY */
- imap_cmd_trycreate_t *cmd2 =
- (imap_cmd_trycreate_t *)new_imap_cmd( sizeof(*cmd2) );
- cmd2->orig_cmd = cmdp;
- cmd2->gen.param.high_prio = 1;
- p = strchr( cmdp->cmd, '"' );
- imap_exec( ctx, &cmd2->gen, get_cmd_result_p2,
- "CREATE %.*s", imap_strchr( p + 1, '"' ) - p + 1, p );
- continue;
- }
- resp = RESP_NO;
- if (cmdp->param.failok)
- goto doresp;
- } else /*if (!strcmp( "BAD", arg ))*/
- resp = RESP_CANCEL;
- error( "IMAP command '%s' returned an error: %s %s\n",
- starts_with( cmdp->cmd, -1, "LOGIN", 5 ) ?
- "LOGIN <user> <pass>" :
- starts_with( cmdp->cmd, -1, "AUTHENTICATE PLAIN", 18 ) ?
- "AUTHENTICATE PLAIN <authdata>" :
- cmdp->cmd,
- arg, cmd ? cmd : "" );
- }
- doresp:
- if ((resp2 = parse_response_code( ctx, cmdp, cmd )) > resp)
- resp = resp2;
- imap_ref( ctx );
- if (resp == RESP_CANCEL)
- imap_invoke_bad_callback( ctx );
- if (resp == RESP_OK && cmdp->param.wait_check) {
- cmdp->next = NULL;
- *ctx->wait_check_append = cmdp;
- ctx->wait_check_append = &cmdp->next;
- } else {
- done_imap_cmd( ctx, cmdp, resp );
- }
- if (imap_deref( ctx ))
- return;
- if (ctx->canceling && !ctx->in_progress) {
- ctx->canceling = 0;
- ctx->callbacks.imap_cancel( ctx->callback_aux );
- return;
- }
- }
- flush_imap_cmds( ctx );
- }
- imap_invoke_bad_callback( ctx );
- }
- static void
- get_cmd_result_p2( imap_store_t *ctx, imap_cmd_t *cmd, int response )
- {
- imap_cmd_trycreate_t *cmdp = (imap_cmd_trycreate_t *)cmd;
- imap_cmd_t *ocmd = cmdp->orig_cmd;
- if (response != RESP_OK) {
- done_imap_cmd( ctx, ocmd, response );
- } else {
- assert( !ocmd->param.wait_check );
- ctx->uidnext = 1;
- if (ocmd->param.to_trash)
- ctx->trashnc = TrashKnown;
- ocmd->param.create = 0;
- ocmd->param.high_prio = 1;
- submit_imap_cmd( ctx, ocmd );
- }
- }
- /******************* imap_cancel_store *******************/
- static void
- imap_cancel_store( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- #ifdef HAVE_LIBSASL
- sasl_dispose( &ctx->sasl );
- #endif
- socket_close( &ctx->conn );
- finalize_checked_imap_cmds( ctx, RESP_CANCEL );
- cancel_sent_imap_cmds( ctx );
- cancel_pending_imap_cmds( ctx );
- free( ctx->ns_prefix );
- free_string_list( ctx->auth_mechs );
- free_generic_messages( ctx->msgs );
- free_string_list( ctx->boxes );
- imap_deref( ctx );
- }
- static int
- imap_deref( imap_store_t *ctx )
- {
- if (!--ctx->ref_count) {
- free( ctx );
- return -1;
- }
- return 0;
- }
- static void
- imap_set_bad_callback( store_t *gctx, void (*cb)( void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- ctx->bad_callback = cb;
- ctx->bad_callback_aux = aux;
- }
- static void
- imap_invoke_bad_callback( imap_store_t *ctx )
- {
- ctx->bad_callback( ctx->bad_callback_aux );
- }
- /******************* imap_free_store *******************/
- static store_t *unowned;
- static void
- imap_cancel_unowned( void *gctx )
- {
- store_t *store, **storep;
- for (storep = &unowned; (store = *storep); storep = &store->next)
- if (store == gctx) {
- *storep = store->next;
- break;
- }
- imap_cancel_store( gctx );
- }
- static void
- imap_free_store( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- assert( !ctx->pending && !ctx->in_progress && !ctx->wait_check );
- free_generic_messages( ctx->msgs );
- ctx->msgs = NULL;
- imap_set_bad_callback( gctx, imap_cancel_unowned, gctx );
- gctx->next = unowned;
- unowned = gctx;
- }
- /******************* imap_cleanup *******************/
- static void imap_cleanup_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_cleanup( void )
- {
- store_t *ctx, *nctx;
- for (ctx = unowned; ctx; ctx = nctx) {
- nctx = ctx->next;
- imap_set_bad_callback( ctx, (void (*)(void *))imap_cancel_store, ctx );
- if (((imap_store_t *)ctx)->state != SST_BAD) {
- ((imap_store_t *)ctx)->expectBYE = 1;
- imap_exec( (imap_store_t *)ctx, NULL, imap_cleanup_p2, "LOGOUT" );
- } else {
- imap_cancel_store( ctx );
- }
- }
- }
- static void
- imap_cleanup_p2( imap_store_t *ctx,
- imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO)
- imap_cancel_store( &ctx->gen );
- else if (response == RESP_OK)
- ctx->expectEOF = 1;
- }
- /******************* imap_open_store *******************/
- static void imap_open_store_connected( int, void * );
- #ifdef HAVE_LIBSSL
- static void imap_open_store_tlsstarted1( int, void * );
- #endif
- static void imap_open_store_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_open_store_authenticate( imap_store_t * );
- #ifdef HAVE_LIBSSL
- static void imap_open_store_authenticate_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_open_store_tlsstarted2( int, void * );
- static void imap_open_store_authenticate_p3( imap_store_t *, imap_cmd_t *, int );
- #endif
- static void imap_open_store_authenticate2( imap_store_t * );
- static void imap_open_store_authenticate2_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_open_store_compress( imap_store_t * );
- #ifdef HAVE_LIBZ
- static void imap_open_store_compress_p2( imap_store_t *, imap_cmd_t *, int );
- #endif
- static void imap_open_store_namespace( imap_store_t * );
- static void imap_open_store_namespace_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_open_store_namespace2( imap_store_t * );
- static void imap_open_store_finalize( imap_store_t * );
- #ifdef HAVE_LIBSSL
- static void imap_open_store_ssl_bail( imap_store_t * );
- #endif
- static void imap_open_store_bail( imap_store_t *, int );
- static store_t *
- imap_alloc_store( store_conf_t *conf, const char *label )
- {
- imap_store_conf_t *cfg = (imap_store_conf_t *)conf;
- imap_server_conf_t *srvc = cfg->server;
- imap_store_t *ctx;
- store_t **ctxp;
- /* First try to recycle a whole store. */
- for (ctxp = &unowned; (ctx = (imap_store_t *)*ctxp); ctxp = &ctx->gen.next)
- if (ctx->state == SST_GOOD && ctx->gen.conf == conf) {
- *ctxp = ctx->gen.next;
- goto gotstore;
- }
- /* Then try to recycle a server connection. */
- for (ctxp = &unowned; (ctx = (imap_store_t *)*ctxp); ctxp = &ctx->gen.next)
- if (ctx->state != SST_BAD && ((imap_store_conf_t *)ctx->gen.conf)->server == srvc) {
- *ctxp = ctx->gen.next;
- free_string_list( ctx->boxes );
- ctx->boxes = NULL;
- ctx->listed = 0;
- /* One could ping the server here, but given that the idle timeout
- * is at least 30 minutes, this sounds pretty pointless. */
- ctx->state = SST_HALF;
- goto gotsrv;
- }
- /* Finally, schedule opening a new server connection. */
- ctx = nfcalloc( sizeof(*ctx) );
- ctx->gen.driver = &imap_driver;
- ctx->ref_count = 1;
- socket_init( &ctx->conn, &srvc->sconf,
- (void (*)( void * ))imap_invoke_bad_callback,
- imap_socket_read, (void (*)(void *))flush_imap_cmds, ctx );
- ctx->in_progress_append = &ctx->in_progress;
- ctx->pending_append = &ctx->pending;
- ctx->wait_check_append = &ctx->wait_check;
- gotsrv:
- ctx->gen.conf = conf;
- gotstore:
- ctx->label = label;
- return &ctx->gen;
- }
- static void
- imap_connect_store( store_t *gctx,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- if (ctx->state == SST_GOOD) {
- cb( DRV_OK, aux );
- } else {
- ctx->callbacks.imap_open = cb;
- ctx->callback_aux = aux;
- if (ctx->state == SST_HALF)
- imap_open_store_namespace( ctx );
- else
- socket_connect( &ctx->conn, imap_open_store_connected );
- }
- }
- static void
- imap_open_store_connected( int ok, void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)aux;
- #ifdef HAVE_LIBSSL
- imap_store_conf_t *cfg = (imap_store_conf_t *)ctx->gen.conf;
- imap_server_conf_t *srvc = cfg->server;
- #endif
- if (!ok)
- imap_open_store_bail( ctx, FAIL_WAIT );
- #ifdef HAVE_LIBSSL
- else if (srvc->ssl_type == SSL_IMAPS)
- socket_start_tls( &ctx->conn, imap_open_store_tlsstarted1 );
- #endif
- else
- socket_expect_activity( &ctx->conn, 1 );
- }
- #ifdef HAVE_LIBSSL
- static void
- imap_open_store_tlsstarted1( int ok, void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)aux;
- if (!ok)
- imap_open_store_ssl_bail( ctx );
- else
- socket_expect_activity( &ctx->conn, 1 );
- }
- #endif
- static void
- imap_open_store_greeted( imap_store_t *ctx )
- {
- socket_expect_activity( &ctx->conn, 0 );
- if (!ctx->caps)
- imap_exec( ctx, NULL, imap_open_store_p2, "CAPABILITY" );
- else
- imap_open_store_authenticate( ctx );
- }
- static void
- imap_open_store_p2( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO)
- imap_open_store_bail( ctx, FAIL_FINAL );
- else if (response == RESP_OK)
- imap_open_store_authenticate( ctx );
- }
- static void
- imap_open_store_authenticate( imap_store_t *ctx )
- {
- #ifdef HAVE_LIBSSL
- imap_store_conf_t *cfg = (imap_store_conf_t *)ctx->gen.conf;
- imap_server_conf_t *srvc = cfg->server;
- #endif
- if (ctx->greeting != GreetingPreauth) {
- #ifdef HAVE_LIBSSL
- if (srvc->ssl_type == SSL_STARTTLS) {
- if (CAP(STARTTLS)) {
- imap_exec( ctx, NULL, imap_open_store_authenticate_p2, "STARTTLS" );
- return;
- } else {
- error( "IMAP error: SSL support not available\n" );
- imap_open_store_bail( ctx, FAIL_FINAL );
- return;
- }
- }
- #endif
- imap_open_store_authenticate2( ctx );
- } else {
- #ifdef HAVE_LIBSSL
- if (srvc->ssl_type == SSL_STARTTLS) {
- error( "IMAP error: SSL support not available\n" );
- imap_open_store_bail( ctx, FAIL_FINAL );
- return;
- }
- #endif
- imap_open_store_compress( ctx );
- }
- }
- #ifdef HAVE_LIBSSL
- static void
- imap_open_store_authenticate_p2( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO)
- imap_open_store_bail( ctx, FAIL_FINAL );
- else if (response == RESP_OK)
- socket_start_tls( &ctx->conn, imap_open_store_tlsstarted2 );
- }
- static void
- imap_open_store_tlsstarted2( int ok, void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)aux;
- if (!ok)
- imap_open_store_ssl_bail( ctx );
- else
- imap_exec( ctx, NULL, imap_open_store_authenticate_p3, "CAPABILITY" );
- }
- static void
- imap_open_store_authenticate_p3( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO)
- imap_open_store_bail( ctx, FAIL_FINAL );
- else if (response == RESP_OK)
- imap_open_store_authenticate2( ctx );
- }
- #endif
- static char *
- cred_from_cmd( const char *cred, const char *cmd, const char *srv_name )
- {
- FILE *fp;
- int ret;
- char buffer[8192]; // Hopefully more than enough room for XOAUTH2, etc. tokens
- if (*cmd == '+') {
- flushn();
- cmd++;
- }
- if (!(fp = popen( cmd, "r" ))) {
- pipeerr:
- sys_error( "Skipping account %s, %s failed", srv_name, cred );
- return NULL;
- }
- if (!fgets( buffer, sizeof(buffer), fp ))
- buffer[0] = 0;
- if ((ret = pclose( fp )) < 0)
- goto pipeerr;
- if (ret) {
- if (WIFSIGNALED( ret ))
- error( "Skipping account %s, %s crashed\n", srv_name, cred );
- else
- error( "Skipping account %s, %s exited with status %d\n", srv_name, cred, WEXITSTATUS( ret ) );
- return NULL;
- }
- if (!buffer[0]) {
- error( "Skipping account %s, %s produced no output\n", srv_name, cred );
- return NULL;
- }
- buffer[strcspn( buffer, "\n" )] = 0; /* Strip trailing newline */
- return nfstrdup( buffer );
- }
- static const char *
- ensure_user( imap_server_conf_t *srvc )
- {
- if (!srvc->user) {
- if (srvc->user_cmd) {
- srvc->user = cred_from_cmd( "UserCmd", srvc->user_cmd, srvc->name );
- } else {
- error( "Skipping account %s, no user\n", srvc->name );
- }
- }
- return srvc->user;
- }
- static const char *
- ensure_password( imap_server_conf_t *srvc )
- {
- if (!srvc->pass) {
- if (srvc->pass_cmd) {
- srvc->pass = cred_from_cmd( "PassCmd", srvc->pass_cmd, srvc->name );
- #ifdef HAVE_MACOS_KEYCHAIN
- } else if (srvc->use_keychain) {
- void *password_data;
- UInt32 password_length;
- OSStatus ret = SecKeychainFindInternetPassword(
- NULL, // keychainOrArray
- strlen( srvc->sconf.host ), srvc->sconf.host,
- 0, NULL, // securityDomain
- strlen( srvc->user ), srvc->user,
- 0, NULL, // path
- 0, // port - we could use it, but it seems pointless
- kSecProtocolTypeIMAP,
- kSecAuthenticationTypeDefault,
- &password_length, &password_data,
- NULL ); // itemRef
- if (ret != errSecSuccess) {
- CFStringRef errmsg = SecCopyErrorMessageString( ret, NULL );
- error( "Looking up Keychain failed: %s\n",
- CFStringGetCStringPtr( errmsg, kCFStringEncodingUTF8 ) );
- CFRelease( errmsg );
- return NULL;
- }
- srvc->pass = nfstrndup( password_data, password_length );
- SecKeychainItemFreeContent( NULL, password_data );
- #endif /* HAVE_MACOS_KEYCHAIN */
- } else {
- flushn();
- char prompt[80];
- sprintf( prompt, "Password (%s): ", srvc->name );
- char *pass = getpass( prompt );
- if (!pass) {
- perror( "getpass" );
- exit( 1 );
- }
- if (!*pass) {
- error( "Skipping account %s, no password\n", srvc->name );
- return NULL;
- }
- /* getpass() returns a pointer to a static buffer. Make a copy for long term storage. */
- srvc->pass = nfstrdup( pass );
- }
- }
- return srvc->pass;
- }
- #ifdef HAVE_LIBSASL
- static sasl_callback_t sasl_callbacks[] = {
- { SASL_CB_USER, NULL, NULL },
- { SASL_CB_AUTHNAME, NULL, NULL },
- { SASL_CB_PASS, NULL, NULL },
- { SASL_CB_LIST_END, NULL, NULL }
- };
- static int
- process_sasl_interact( sasl_interact_t *interact, imap_server_conf_t *srvc )
- {
- const char *val;
- for (;; ++interact) {
- switch (interact->id) {
- case SASL_CB_LIST_END:
- return 0;
- case SASL_CB_USER:
- case SASL_CB_AUTHNAME:
- val = ensure_user( srvc );
- break;
- case SASL_CB_PASS:
- val = ensure_password( srvc );
- break;
- default:
- error( "Error: Unknown SASL interaction ID\n" );
- return -1;
- }
- if (!val)
- return -1;
- interact->result = val;
- interact->len = strlen( val );
- }
- }
- static int
- process_sasl_step( imap_store_t *ctx, int rc, const char *in, uint in_len,
- sasl_interact_t *interact, const char **out, uint *out_len )
- {
- imap_server_conf_t *srvc = ((imap_store_conf_t *)ctx->gen.conf)->server;
- while (rc == SASL_INTERACT) {
- if (process_sasl_interact( interact, srvc ) < 0)
- return -1;
- rc = sasl_client_step( ctx->sasl, in, in_len, &interact, out, out_len );
- }
- if (rc == SASL_CONTINUE) {
- ctx->sasl_cont = 1;
- } else if (rc == SASL_OK) {
- ctx->sasl_cont = 0;
- } else {
- error( "Error: %s\n", sasl_errdetail( ctx->sasl ) );
- return -1;
- }
- return 0;
- }
- static int
- decode_sasl_data( const char *prompt, char **in, uint *in_len )
- {
- if (prompt) {
- int rc;
- uint prompt_len = strlen( prompt );
- /* We're decoding, the output will be shorter than prompt_len. */
- *in = nfmalloc( prompt_len );
- rc = sasl_decode64( prompt, prompt_len, *in, prompt_len, in_len );
- if (rc != SASL_OK) {
- free( *in );
- error( "Error: SASL(%d): %s\n", rc, sasl_errstring( rc, NULL, NULL ) );
- return -1;
- }
- } else {
- *in = NULL;
- *in_len = 0;
- }
- return 0;
- }
- static int
- encode_sasl_data( const char *out, uint out_len, char **enc, uint *enc_len )
- {
- int rc;
- uint enc_len_max = ((out_len + 2) / 3) * 4 + 1;
- *enc = nfmalloc( enc_len_max );
- rc = sasl_encode64( out, out_len, *enc, enc_len_max, enc_len );
- if (rc != SASL_OK) {
- free( *enc );
- error( "Error: SASL(%d): %s\n", rc, sasl_errstring( rc, NULL, NULL ) );
- return -1;
- }
- return 0;
- }
- static int
- do_sasl_auth( imap_store_t *ctx, imap_cmd_t *cmdp ATTR_UNUSED, const char *prompt )
- {
- int rc, ret, iovcnt = 0;
- uint in_len, out_len, enc_len;
- const char *out;
- char *in, *enc;
- sasl_interact_t *interact = NULL;
- conn_iovec_t iov[2];
- if (!ctx->sasl_cont) {
- error( "Error: IMAP wants more steps despite successful SASL authentication.\n" );
- goto bail;
- }
- if (decode_sasl_data( prompt, &in, &in_len ) < 0)
- goto bail;
- rc = sasl_client_step( ctx->sasl, in, in_len, &interact, &out, &out_len );
- ret = process_sasl_step( ctx, rc, in, in_len, interact, &out, &out_len );
- free( in );
- if (ret < 0)
- goto bail;
- if (out) {
- if (encode_sasl_data( out, out_len, &enc, &enc_len ) < 0)
- goto bail;
- iov[0].buf = enc;
- iov[0].len = enc_len;
- iov[0].takeOwn = GiveOwn;
- iovcnt = 1;
- if (DFlags & DEBUG_NET) {
- printf( "%s>+> %s\n", ctx->label, enc );
- fflush( stdout );
- }
- } else {
- if (DFlags & DEBUG_NET) {
- printf( "%s>+>\n", ctx->label );
- fflush( stdout );
- }
- }
- iov[iovcnt].buf = "\r\n";
- iov[iovcnt].len = 2;
- iov[iovcnt].takeOwn = KeepOwn;
- iovcnt++;
- socket_write( &ctx->conn, iov, iovcnt );
- return 0;
- bail:
- imap_open_store_bail( ctx, FAIL_FINAL );
- return -1;
- }
- static void
- done_sasl_auth( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_OK && ctx->sasl_cont) {
- sasl_interact_t *interact = NULL;
- const char *out;
- uint out_len;
- int rc = sasl_client_step( ctx->sasl, NULL, 0, &interact, &out, &out_len );
- if (process_sasl_step( ctx, rc, NULL, 0, interact, &out, &out_len ) < 0)
- warn( "Warning: SASL reported failure despite successful IMAP authentication. Ignoring...\n" );
- else if (out_len > 0)
- warn( "Warning: SASL wants more steps despite successful IMAP authentication. Ignoring...\n" );
- }
- imap_open_store_authenticate2_p2( ctx, NULL, response );
- }
- #endif
- static void
- imap_open_store_authenticate2( imap_store_t *ctx )
- {
- imap_store_conf_t *cfg = (imap_store_conf_t *)ctx->gen.conf;
- imap_server_conf_t *srvc = cfg->server;
- string_list_t *mech, *cmech;
- int auth_login = 0;
- int skipped_login = 0;
- #ifdef HAVE_LIBSASL
- const char *saslavail;
- char saslmechs[1024], *saslend = saslmechs;
- #endif
- // Ensure that there are no leftovers from previous runs. This is needed in case
- // the credentials have a timing dependency or otherwise lose validity after use.
- if (srvc->user_cmd) {
- free( srvc->user );
- srvc->user = NULL;
- }
- if (srvc->pass_cmd) {
- free( srvc->pass );
- srvc->pass = NULL;
- }
- info( "Logging in...\n" );
- for (mech = srvc->auth_mechs; mech; mech = mech->next) {
- int any = !strcmp( mech->string, "*" );
- for (cmech = ctx->auth_mechs; cmech; cmech = cmech->next) {
- if (any || !strcasecmp( mech->string, cmech->string )) {
- if (!strcasecmp( cmech->string, "LOGIN" )) {
- #ifdef HAVE_LIBSSL
- if (ctx->conn.ssl || !any)
- #else
- if (!any)
- #endif
- auth_login = 1;
- else
- skipped_login = 1;
- #ifdef HAVE_LIBSASL
- } else {
- uint len = strlen( cmech->string );
- if (saslend + len + 2 > saslmechs + sizeof(saslmechs))
- oob();
- *saslend++ = ' ';
- memcpy( saslend, cmech->string, len + 1 );
- saslend += len;
- #endif
- }
- }
- }
- }
- #ifdef HAVE_LIBSASL
- if (saslend != saslmechs) {
- int rc;
- uint out_len = 0;
- char *enc = NULL;
- const char *gotmech = NULL, *out = NULL;
- sasl_interact_t *interact = NULL;
- imap_cmd_t *cmd;
- static int sasl_inited;
- if (!sasl_inited) {
- rc = sasl_client_init( sasl_callbacks );
- if (rc != SASL_OK) {
- saslbail:
- error( "Error: SASL(%d): %s\n", rc, sasl_errstring( rc, NULL, NULL ) );
- goto bail;
- }
- sasl_inited = 1;
- }
- rc = sasl_client_new( "imap", srvc->sconf.host, NULL, NULL, NULL, 0, &ctx->sasl );
- if (rc != SASL_OK) {
- if (rc == SASL_NOMECH)
- goto notsasl;
- if (!ctx->sasl)
- goto saslbail;
- error( "Error: %s\n", sasl_errdetail( ctx->sasl ) );
- goto bail;
- }
- rc = sasl_client_start( ctx->sasl, saslmechs + 1, &interact, CAP(SASLIR) ? &out : NULL, &out_len, &gotmech );
- if (rc == SASL_NOMECH)
- goto notsasl;
- if (gotmech)
- info( "Authenticating with SASL mechanism %s...\n", gotmech );
- /* Technically, we are supposed to loop over sasl_client_start(),
- * but it just calls sasl_client_step() anyway. */
- if (process_sasl_step( ctx, rc, NULL, 0, interact, CAP(SASLIR) ? &out : NULL, &out_len ) < 0)
- goto bail;
- if (out) {
- if (!out_len)
- enc = nfstrdup( "=" ); /* A zero-length initial response is encoded as padding. */
- else if (encode_sasl_data( out, out_len, &enc, NULL ) < 0)
- goto bail;
- }
- cmd = new_imap_cmd( sizeof(*cmd) );
- cmd->param.cont = do_sasl_auth;
- imap_exec( ctx, cmd, done_sasl_auth, enc ? "AUTHENTICATE %s %s" : "AUTHENTICATE %s", gotmech, enc );
- free( enc );
- return;
- notsasl:
- if (!ctx->sasl || sasl_listmech( ctx->sasl, NULL, "", " ", "", &saslavail, NULL, NULL ) != SASL_OK)
- saslavail = "(none)"; /* EXTERNAL is always there anyway. */
- if (!auth_login) {
- error( "IMAP error: selected SASL mechanism(s) not available;\n"
- " selected:%s\n available: %s\n", saslmechs, saslavail );
- goto skipnote;
- }
- info( "NOT using available SASL mechanism(s): %s\n", saslavail );
- sasl_dispose( &ctx->sasl );
- }
- #endif
- if (auth_login) {
- if (!ensure_user( srvc ) || !ensure_password( srvc ))
- goto bail;
- #ifdef HAVE_LIBSSL
- if (!ctx->conn.ssl)
- #endif
- warn( "*** IMAP Warning *** Password is being sent in the clear\n" );
- imap_exec( ctx, NULL, imap_open_store_authenticate2_p2,
- "LOGIN \"%\\s\" \"%\\s\"", srvc->user, srvc->pass );
- return;
- }
- error( "IMAP error: server supports no acceptable authentication mechanism\n" );
- #ifdef HAVE_LIBSASL
- skipnote:
- #endif
- if (skipped_login)
- error( "Note: not using LOGIN because connection is not encrypted;\n"
- " use 'AuthMechs LOGIN' explicitly to force it.\n" );
- bail:
- imap_open_store_bail( ctx, FAIL_FINAL );
- }
- static void
- imap_open_store_authenticate2_p2( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO)
- imap_open_store_bail( ctx, FAIL_FINAL );
- else if (response == RESP_OK)
- imap_open_store_compress( ctx );
- }
- static void
- imap_open_store_compress( imap_store_t *ctx )
- {
- #ifdef HAVE_LIBZ
- if (CAP(COMPRESS_DEFLATE)) {
- imap_exec( ctx, NULL, imap_open_store_compress_p2, "COMPRESS DEFLATE" );
- return;
- }
- #endif
- imap_open_store_namespace( ctx );
- }
- #ifdef HAVE_LIBZ
- static void
- imap_open_store_compress_p2( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO) {
- /* We already reported an error, but it's not fatal to us. */
- imap_open_store_namespace( ctx );
- } else if (response == RESP_OK) {
- socket_start_deflate( &ctx->conn );
- imap_open_store_namespace( ctx );
- }
- }
- #endif
- static void
- imap_open_store_namespace( imap_store_t *ctx )
- {
- imap_store_conf_t *cfg = (imap_store_conf_t *)ctx->gen.conf;
- ctx->state = SST_HALF;
- ctx->prefix = cfg->gen.path;
- ctx->delimiter[0] = cfg->delimiter;
- if (((!ctx->prefix && cfg->use_namespace) || !cfg->delimiter) && CAP(NAMESPACE)) {
- /* get NAMESPACE info */
- if (!ctx->got_namespace)
- imap_exec( ctx, NULL, imap_open_store_namespace_p2, "NAMESPACE" );
- else
- imap_open_store_namespace2( ctx );
- return;
- }
- imap_open_store_finalize( ctx );
- }
- static void
- imap_open_store_namespace_p2( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- if (response == RESP_NO) {
- imap_open_store_bail( ctx, FAIL_FINAL );
- } else if (response == RESP_OK) {
- ctx->got_namespace = 1;
- imap_open_store_namespace2( ctx );
- }
- }
- static void
- imap_open_store_namespace2( imap_store_t *ctx )
- {
- imap_store_conf_t *cfg = (imap_store_conf_t *)ctx->gen.conf;
- if (!ctx->prefix && cfg->use_namespace)
- ctx->prefix = ctx->ns_prefix;
- if (!ctx->delimiter[0])
- ctx->delimiter[0] = ctx->ns_delimiter;
- imap_open_store_finalize( ctx );
- }
- static void
- imap_open_store_finalize( imap_store_t *ctx )
- {
- ctx->state = SST_GOOD;
- if (!ctx->prefix)
- ctx->prefix = "";
- ctx->trashnc = TrashUnknown;
- ctx->callbacks.imap_open( DRV_OK, ctx->callback_aux );
- }
- #ifdef HAVE_LIBSSL
- static void
- imap_open_store_ssl_bail( imap_store_t *ctx )
- {
- /* This avoids that we try to send LOGOUT to an unusable socket. */
- socket_close( &ctx->conn );
- imap_open_store_bail( ctx, FAIL_FINAL );
- }
- #endif
- static void
- imap_open_store_bail( imap_store_t *ctx, int failed )
- {
- ((imap_store_conf_t *)ctx->gen.conf)->server->failed = (char)failed;
- ctx->callbacks.imap_open( DRV_STORE_BAD, ctx->callback_aux );
- }
- /******************* imap_open_box *******************/
- static int
- imap_select_box( store_t *gctx, const char *name )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- assert( !ctx->pending && !ctx->in_progress && !ctx->wait_check );
- free_generic_messages( ctx->msgs );
- ctx->msgs = NULL;
- ctx->msgapp = &ctx->msgs;
- ctx->name = name;
- return DRV_OK;
- }
- static const char *
- imap_get_box_path( store_t *gctx ATTR_UNUSED )
- {
- return NULL;
- }
- typedef struct {
- imap_cmd_t gen;
- void (*callback)( int sts, uint uidvalidity, void *aux );
- void *callback_aux;
- } imap_cmd_open_box_t;
- static void imap_open_box_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_open_box_p3( imap_store_t *, imap_cmd_t *, int );
- static void imap_open_box_p4( imap_store_t *, imap_cmd_open_box_t *, int );
- static void
- imap_open_box( store_t *gctx,
- void (*cb)( int sts, uint uidvalidity, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_cmd_open_box_t *cmd;
- char *buf;
- if (prepare_box( &buf, ctx ) < 0) {
- cb( DRV_BOX_BAD, UIDVAL_BAD, aux );
- return;
- }
- ctx->uidvalidity = UIDVAL_BAD;
- ctx->uidnext = 0;
- INIT_IMAP_CMD(imap_cmd_open_box_t, cmd, cb, aux)
- cmd->gen.param.failok = 1;
- imap_exec( ctx, &cmd->gen, imap_open_box_p2,
- "SELECT \"%\\s\"", buf );
- free( buf );
- }
- static void
- imap_open_box_p2( imap_store_t *ctx, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_open_box_t *cmdp = (imap_cmd_open_box_t *)gcmd;
- imap_cmd_open_box_t *cmd;
- if (response != RESP_OK || ctx->uidnext) {
- imap_open_box_p4( ctx, cmdp, response );
- return;
- }
- assert( ctx->fetch_sts == FetchNone );
- ctx->fetch_sts = FetchUidNext;
- INIT_IMAP_CMD(imap_cmd_open_box_t, cmd, cmdp->callback, cmdp->callback_aux)
- imap_exec( ctx, &cmd->gen, imap_open_box_p3,
- "UID FETCH * (UID)" );
- }
- static void
- imap_open_box_p3( imap_store_t *ctx, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_open_box_t *cmdp = (imap_cmd_open_box_t *)gcmd;
- ctx->fetch_sts = FetchNone;
- if (!ctx->uidnext) {
- if (ctx->total_msgs) {
- error( "IMAP error: querying server for highest UID failed\n" );
- imap_open_box_p4( ctx, cmdp, RESP_NO );
- return;
- }
- // This is ok, the box is simply empty.
- ctx->uidnext = 1;
- }
- imap_open_box_p4( ctx, cmdp, response );
- }
- static void
- imap_open_box_p4( imap_store_t *ctx, imap_cmd_open_box_t *cmdp, int response )
- {
- transform_box_response( &response );
- cmdp->callback( response, ctx->uidvalidity, cmdp->callback_aux );
- }
- static uint
- imap_get_uidnext( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- return ctx->uidnext;
- }
- static xint
- imap_get_supported_flags( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- return ctx->has_forwarded ? 255 : (255 & ~F_FORWARDED);
- }
- /******************* imap_create_box *******************/
- static void
- imap_create_box( store_t *gctx,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_cmd_simple_t *cmd;
- char *buf;
- if (prepare_box( &buf, ctx ) < 0) {
- cb( DRV_BOX_BAD, aux );
- return;
- }
- INIT_IMAP_CMD(imap_cmd_simple_t, cmd, cb, aux)
- imap_exec( ctx, &cmd->gen, imap_done_simple_box,
- "CREATE \"%\\s\"", buf );
- free( buf );
- }
- /******************* imap_delete_box *******************/
- static int
- imap_confirm_box_empty( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- return ctx->total_msgs ? DRV_BOX_BAD : DRV_OK;
- }
- static void imap_delete_box_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_delete_box( store_t *gctx,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_cmd_simple_t *cmd;
- INIT_IMAP_CMD(imap_cmd_simple_t, cmd, cb, aux)
- imap_exec( ctx, &cmd->gen, imap_delete_box_p2, "CLOSE" );
- }
- static void
- imap_delete_box_p2( imap_store_t *ctx, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_simple_t *cmdp = (imap_cmd_simple_t *)gcmd;
- imap_cmd_simple_t *cmd;
- char *buf;
- if (response != RESP_OK) {
- imap_done_simple_box( ctx, &cmdp->gen, response );
- return;
- }
- if (prepare_box( &buf, ctx ) < 0) {
- imap_done_simple_box( ctx, &cmdp->gen, RESP_NO );
- return;
- }
- INIT_IMAP_CMD(imap_cmd_simple_t, cmd, cmdp->callback, cmdp->callback_aux)
- imap_exec( ctx, &cmd->gen, imap_done_simple_box,
- "DELETE \"%\\s\"", buf );
- free( buf );
- }
- static int
- imap_finish_delete_box( store_t *gctx ATTR_UNUSED )
- {
- return DRV_OK;
- }
- /******************* imap_load_box *******************/
- static uint
- imap_prepare_load_box( store_t *gctx, uint opts )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- ctx->opts = opts;
- return opts;
- }
- enum { WantSize = 1, WantTuids = 2, WantMsgids = 4 };
- typedef struct {
- uint first, last;
- int flags;
- } imap_range_t;
- static void
- imap_set_range( imap_range_t *ranges, uint *nranges, int low_flags, int high_flags, uint maxlow )
- {
- if (low_flags != high_flags) {
- for (uint r = 0; r < *nranges; r++) {
- if (ranges[r].first > maxlow)
- break; /* Range starts above split point; so do all subsequent ranges. */
- if (ranges[r].last < maxlow)
- continue; /* Range ends below split point; try next one. */
- if (ranges[r].last != maxlow) {
- /* Range does not end exactly at split point; need to split. */
- memmove( &ranges[r + 1], &ranges[r], ((*nranges)++ - r) * sizeof(*ranges) );
- ranges[r].last = maxlow;
- ranges[r + 1].first = maxlow + 1;
- }
- break;
- }
- }
- for (uint r = 0; r < *nranges; r++)
- ranges[r].flags |= (ranges[r].last <= maxlow) ? low_flags : high_flags;
- }
- typedef struct {
- imap_cmd_refcounted_state_t gen;
- void (*callback)( int sts, message_t *msgs, int total_msgs, int recent_msgs, void *aux );
- void *callback_aux;
- } imap_load_box_state_t;
- static void imap_submit_load( imap_store_t *, const char *, int, imap_load_box_state_t * );
- static void imap_submit_load_p3( imap_store_t *ctx, imap_load_box_state_t * );
- static void
- imap_load_box( store_t *gctx, uint minuid, uint maxuid, uint finduid, uint pairuid, uint newuid, uint_array_t excs,
- void (*cb)( int sts, message_t *msgs, int total_msgs, int recent_msgs, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- char buf[1000];
- if (!ctx->total_msgs) {
- free( excs.data );
- cb( DRV_OK, NULL, 0, 0, aux );
- } else {
- assert( ctx->fetch_sts == FetchNone );
- ctx->fetch_sts = FetchMsgs;
- INIT_REFCOUNTED_STATE(imap_load_box_state_t, sts, cb, aux)
- for (uint i = 0; i < excs.size; ) {
- for (int bl = 0; i < excs.size && bl < 960; i++) {
- if (bl)
- buf[bl++] = ',';
- bl += sprintf( buf + bl, "%u", excs.data[i] );
- uint j = i;
- for (; i + 1 < excs.size && excs.data[i + 1] == excs.data[i] + 1; i++) {}
- if (i != j)
- bl += sprintf( buf + bl, ":%u", excs.data[i] );
- }
- imap_submit_load( ctx, buf, shifted_bit( ctx->opts, OPEN_OLD_IDS, WantMsgids ), sts );
- }
- if (maxuid == UINT_MAX)
- maxuid = ctx->uidnext - 1;
- if (maxuid >= minuid) {
- imap_range_t ranges[3];
- ranges[0].first = minuid;
- ranges[0].last = maxuid;
- ranges[0].flags = 0;
- uint nranges = 1;
- if (ctx->opts & OPEN_NEW_SIZE)
- imap_set_range( ranges, &nranges, 0, WantSize, newuid );
- if (ctx->opts & OPEN_FIND)
- imap_set_range( ranges, &nranges, 0, WantTuids, finduid - 1 );
- if (ctx->opts & OPEN_OLD_IDS)
- imap_set_range( ranges, &nranges, WantMsgids, 0, pairuid );
- for (uint r = 0; r < nranges; r++) {
- sprintf( buf, "%u:%u", ranges[r].first, ranges[r].last );
- imap_submit_load( ctx, buf, ranges[r].flags, sts );
- }
- }
- free( excs.data );
- imap_submit_load_p3( ctx, sts );
- }
- }
- static int
- imap_sort_msgs_comp( const void *a_, const void *b_ )
- {
- const message_t *a = *(const message_t * const *)a_;
- const message_t *b = *(const message_t * const *)b_;
- if (a->uid < b->uid)
- return -1;
- if (a->uid > b->uid)
- return 1;
- return 0;
- }
- static void
- imap_sort_msgs( imap_store_t *ctx )
- {
- uint count = count_generic_messages( ctx->msgs );
- if (count <= 1)
- return;
- message_t **t = nfmalloc( sizeof(*t) * count );
- message_t *m = ctx->msgs;
- for (uint i = 0; i < count; i++) {
- t[i] = m;
- m = m->next;
- }
- qsort( t, count, sizeof(*t), imap_sort_msgs_comp );
- ctx->msgs = t[0];
- uint j;
- for (j = 0; j < count - 1; j++)
- t[j]->next = t[j + 1];
- ctx->msgapp = &t[j]->next;
- *ctx->msgapp = NULL;
- free( t );
- }
- static void imap_submit_load_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_submit_load( imap_store_t *ctx, const char *buf, int flags, imap_load_box_state_t *sts )
- {
- imap_exec( ctx, imap_refcounted_new_cmd( &sts->gen ), imap_submit_load_p2,
- "UID FETCH %s (UID%s%s%s%s%s%s%s)", buf,
- (ctx->opts & OPEN_FLAGS) ? " FLAGS" : "",
- (flags & WantSize) ? " RFC822.SIZE" : "",
- (flags & (WantTuids | WantMsgids)) ? " BODY.PEEK[HEADER.FIELDS (" : "",
- (flags & WantTuids) ? "X-TUID" : "",
- !(~flags & (WantTuids | WantMsgids)) ? " " : "",
- (flags & WantMsgids) ? "MESSAGE-ID" : "",
- (flags & (WantTuids | WantMsgids)) ? ")]" : "");
- }
- static void
- imap_submit_load_p2( imap_store_t *ctx, imap_cmd_t *cmd, int response )
- {
- imap_load_box_state_t *sts = (imap_load_box_state_t *)((imap_cmd_refcounted_t *)cmd)->state;
- transform_refcounted_box_response( &sts->gen, response );
- imap_submit_load_p3( ctx, sts );
- }
- static void
- imap_submit_load_p3( imap_store_t *ctx, imap_load_box_state_t *sts )
- {
- DONE_REFCOUNTED_STATE_ARGS(sts, {
- ctx->fetch_sts = FetchNone;
- if (sts->gen.ret_val == DRV_OK)
- imap_sort_msgs( ctx );
- }, ctx->msgs, ctx->total_msgs, ctx->recent_msgs)
- }
- /******************* imap_fetch_msg *******************/
- static void imap_fetch_msg_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_fetch_msg( store_t *ctx, message_t *msg, msg_data_t *data, int minimal,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_cmd_fetch_msg_t *cmd;
- INIT_IMAP_CMD_X(imap_cmd_fetch_msg_t, cmd, cb, aux)
- cmd->gen.gen.param.uid = msg->uid;
- cmd->msg_data = data;
- data->data = NULL;
- imap_exec( (imap_store_t *)ctx, &cmd->gen.gen, imap_fetch_msg_p2,
- "UID FETCH %u (%s%sBODY.PEEK[%s])", msg->uid,
- !(msg->status & M_FLAGS) ? "FLAGS " : "",
- (data->date== -1) ? "INTERNALDATE " : "",
- minimal ? "HEADER" : "" );
- }
- static void
- imap_fetch_msg_p2( imap_store_t *ctx, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_fetch_msg_t *cmd = (imap_cmd_fetch_msg_t *)gcmd;
- if (response == RESP_OK && !cmd->msg_data->data) {
- /* The FETCH succeeded, but there is no message with this UID. */
- response = RESP_NO;
- }
- imap_done_simple_msg( ctx, gcmd, response );
- }
- /******************* imap_set_msg_flags *******************/
- static uint
- imap_make_flags( int flags, char *buf )
- {
- const char *s;
- uint i, d;
- for (i = d = 0; i < as(Flags); i++)
- if (flags & (1 << i)) {
- buf[d++] = ' ';
- for (s = Flags[i]; *s; s++)
- buf[d++] = *s;
- }
- buf[0] = '(';
- buf[d++] = ')';
- return d;
- }
- typedef struct {
- imap_cmd_refcounted_state_t gen;
- void (*callback)( int sts, void *aux );
- void *callback_aux;
- } imap_set_msg_flags_state_t;
- static void imap_set_flags_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_set_flags_p3( imap_set_msg_flags_state_t * );
- static void
- imap_flags_helper( imap_store_t *ctx, uint uid, char what, int flags,
- imap_set_msg_flags_state_t *sts )
- {
- char buf[256];
- buf[imap_make_flags( flags, buf )] = 0;
- imap_cmd_t *cmd = imap_refcounted_new_cmd( &sts->gen );
- cmd->param.wait_check = 1;
- imap_exec( ctx, cmd, imap_set_flags_p2,
- "UID STORE %u %cFLAGS.SILENT %s", uid, what, buf );
- }
- static void
- imap_set_msg_flags( store_t *gctx, message_t *msg, uint uid, int add, int del,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- if (msg) {
- uid = msg->uid;
- add &= ~msg->flags;
- del &= msg->flags;
- msg->flags |= add;
- msg->flags &= ~del;
- }
- if (add || del) {
- INIT_REFCOUNTED_STATE(imap_set_msg_flags_state_t, sts, cb, aux)
- if (add)
- imap_flags_helper( ctx, uid, '+', add, sts );
- if (del)
- imap_flags_helper( ctx, uid, '-', del, sts );
- imap_set_flags_p3( sts );
- } else {
- cb( DRV_OK, aux );
- }
- }
- static void
- imap_set_flags_p2( imap_store_t *ctx ATTR_UNUSED, imap_cmd_t *cmd, int response )
- {
- imap_set_msg_flags_state_t *sts = (imap_set_msg_flags_state_t *)((imap_cmd_refcounted_t *)cmd)->state;
- transform_refcounted_msg_response( &sts->gen, response);
- imap_set_flags_p3( sts );
- }
- static void
- imap_set_flags_p3( imap_set_msg_flags_state_t *sts )
- {
- DONE_REFCOUNTED_STATE(sts)
- }
- /******************* imap_close_box *******************/
- typedef struct {
- imap_cmd_refcounted_state_t gen;
- void (*callback)( int sts, void *aux );
- void *callback_aux;
- } imap_expunge_state_t;
- static void imap_close_box_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_close_box_p3( imap_expunge_state_t * );
- static void
- imap_close_box( store_t *gctx,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- assert( !ctx->num_wait_check );
- if (ctx->gen.conf->trash && CAP(UIDPLUS)) {
- INIT_REFCOUNTED_STATE(imap_expunge_state_t, sts, cb, aux)
- message_t *msg, *fmsg, *nmsg;
- int bl;
- char buf[1000];
- for (msg = ctx->msgs; ; ) {
- for (bl = 0; msg && bl < 960; msg = msg->next) {
- if (!(msg->flags & F_DELETED))
- continue;
- if (bl)
- buf[bl++] = ',';
- bl += sprintf( buf + bl, "%u", msg->uid );
- fmsg = msg;
- for (; (nmsg = msg->next) && (nmsg->flags & F_DELETED); msg = nmsg) {}
- if (msg != fmsg)
- bl += sprintf( buf + bl, ":%u", msg->uid );
- }
- if (!bl)
- break;
- imap_exec( ctx, imap_refcounted_new_cmd( &sts->gen ), imap_close_box_p2,
- "UID EXPUNGE %s", buf );
- }
- imap_close_box_p3( sts );
- } else {
- /* This is inherently racy: it may cause messages which other clients
- * marked as deleted to be expunged without being trashed. */
- imap_cmd_simple_t *cmd;
- INIT_IMAP_CMD(imap_cmd_simple_t, cmd, cb, aux)
- imap_exec( ctx, &cmd->gen, imap_done_simple_box, "CLOSE" );
- }
- }
- static void
- imap_close_box_p2( imap_store_t *ctx ATTR_UNUSED, imap_cmd_t *cmd, int response )
- {
- imap_expunge_state_t *sts = (imap_expunge_state_t *)((imap_cmd_refcounted_t *)cmd)->state;
- transform_refcounted_box_response( &sts->gen, response );
- imap_close_box_p3( sts );
- }
- static void
- imap_close_box_p3( imap_expunge_state_t *sts )
- {
- DONE_REFCOUNTED_STATE(sts)
- }
- /******************* imap_trash_msg *******************/
- static void
- imap_trash_msg( store_t *gctx, message_t *msg,
- void (*cb)( int sts, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_cmd_simple_t *cmd;
- char *buf;
- INIT_IMAP_CMD(imap_cmd_simple_t, cmd, cb, aux)
- cmd->gen.param.create = 1;
- cmd->gen.param.to_trash = 1;
- if (prepare_trash( &buf, ctx ) < 0) {
- cb( DRV_BOX_BAD, aux );
- return;
- }
- imap_exec( ctx, &cmd->gen, imap_done_simple_msg,
- CAP(MOVE) ? "UID MOVE %u \"%\\s\"" : "UID COPY %u \"%\\s\"", msg->uid, buf );
- free( buf );
- }
- /******************* imap_store_msg *******************/
- static void imap_store_msg_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_store_msg( store_t *gctx, msg_data_t *data, int to_trash,
- void (*cb)( int sts, uint uid, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_cmd_out_uid_t *cmd;
- char *buf;
- uint d;
- char flagstr[128], datestr[64];
- d = 0;
- if (data->flags) {
- d = imap_make_flags( data->flags, flagstr );
- flagstr[d++] = ' ';
- }
- flagstr[d] = 0;
- INIT_IMAP_CMD(imap_cmd_out_uid_t, cmd, cb, aux)
- ctx->buffer_mem += data->len;
- cmd->gen.param.data_len = data->len;
- cmd->gen.param.data = data->data;
- cmd->out_uid = 0;
- if (to_trash) {
- cmd->gen.param.create = 1;
- cmd->gen.param.to_trash = 1;
- if (prepare_trash( &buf, ctx ) < 0) {
- cb( DRV_BOX_BAD, 0, aux );
- return;
- }
- } else {
- if (prepare_box( &buf, ctx ) < 0) {
- cb( DRV_BOX_BAD, 0, aux );
- return;
- }
- }
- if (data->date) {
- /* configure ensures that %z actually works. */
- DIAG_PUSH
- DIAG_DISABLE("-Wformat")
- strftime( datestr, sizeof(datestr), "%d-%b-%Y %H:%M:%S %z", localtime( &data->date ) );
- DIAG_POP
- imap_exec( ctx, &cmd->gen, imap_store_msg_p2,
- "APPEND \"%\\s\" %s\"%\\s\" ", buf, flagstr, datestr );
- } else {
- imap_exec( ctx, &cmd->gen, imap_store_msg_p2,
- "APPEND \"%\\s\" %s", buf, flagstr );
- }
- free( buf );
- }
- static void
- imap_store_msg_p2( imap_store_t *ctx ATTR_UNUSED, imap_cmd_t *cmd, int response )
- {
- imap_cmd_out_uid_t *cmdp = (imap_cmd_out_uid_t *)cmd;
- transform_msg_response( &response );
- cmdp->callback( response, cmdp->out_uid, cmdp->callback_aux );
- }
- /******************* imap_find_new_msgs *******************/
- static void imap_find_new_msgs_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_find_new_msgs_p3( imap_store_t *, imap_cmd_t *, int );
- static void imap_find_new_msgs_p4( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_find_new_msgs( store_t *gctx, uint newuid,
- void (*cb)( int sts, message_t *msgs, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_cmd_find_new_t *cmd;
- INIT_IMAP_CMD(imap_cmd_find_new_t, cmd, cb, aux)
- cmd->out_msgs = ctx->msgapp;
- cmd->uid = newuid;
- // Some servers fail to enumerate recently STOREd messages without syncing first.
- imap_exec( (imap_store_t *)ctx, &cmd->gen, imap_find_new_msgs_p2, "CHECK" );
- }
- static void
- imap_find_new_msgs_p2( imap_store_t *ctx, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_find_new_t *cmdp = (imap_cmd_find_new_t *)gcmd;
- imap_cmd_find_new_t *cmd;
- if (response != RESP_OK) {
- imap_done_simple_box( ctx, gcmd, response );
- return;
- }
- // We appended messages, so we need to re-query UIDNEXT.
- ctx->uidnext = 0;
- assert( ctx->fetch_sts == FetchNone );
- ctx->fetch_sts = FetchUidNext;
- INIT_IMAP_CMD(imap_cmd_find_new_t, cmd, cmdp->callback, cmdp->callback_aux)
- cmd->out_msgs = cmdp->out_msgs;
- cmd->uid = cmdp->uid;
- imap_exec( ctx, &cmd->gen, imap_find_new_msgs_p3,
- "UID FETCH * (UID)" );
- }
- static void
- imap_find_new_msgs_p3( imap_store_t *ctx, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_find_new_t *cmdp = (imap_cmd_find_new_t *)gcmd;
- imap_cmd_find_new_t *cmd;
- ctx->fetch_sts = FetchNone;
- if (response != RESP_OK) {
- imap_find_new_msgs_p4( ctx, gcmd, response );
- return;
- }
- if (ctx->uidnext <= cmdp->uid) {
- if (!ctx->uidnext && ctx->total_msgs) {
- error( "IMAP error: re-querying server for highest UID failed\n" );
- imap_find_new_msgs_p4( ctx, gcmd, RESP_NO );
- } else {
- // The messages evaporated, or the server just didn't register them -
- // we'll catch that later (via lost TUIDs).
- // This case is why we do the extra roundtrip instead of simply passing
- // '*' as the end of the range below - IMAP ranges are unordered, so we
- // would potentially re-fetch an already loaded message.
- imap_find_new_msgs_p4( ctx, gcmd, RESP_OK );
- }
- return;
- }
- INIT_IMAP_CMD(imap_cmd_find_new_t, cmd, cmdp->callback, cmdp->callback_aux)
- cmd->out_msgs = cmdp->out_msgs;
- imap_exec( (imap_store_t *)ctx, &cmd->gen, imap_find_new_msgs_p4,
- "UID FETCH %u:%u (UID BODY.PEEK[HEADER.FIELDS (X-TUID)])", cmdp->uid, ctx->uidnext - 1 );
- }
- static void
- imap_find_new_msgs_p4( imap_store_t *ctx ATTR_UNUSED, imap_cmd_t *gcmd, int response )
- {
- imap_cmd_find_new_t *cmdp = (imap_cmd_find_new_t *)gcmd;
- transform_box_response( &response );
- cmdp->callback( response, *cmdp->out_msgs, cmdp->callback_aux );
- }
- /******************* imap_list_store *******************/
- typedef struct {
- imap_cmd_refcounted_state_t gen;
- void (*callback)( int sts, string_list_t *, void *aux );
- void *callback_aux;
- } imap_list_store_state_t;
- static void imap_list_store_p2( imap_store_t *, imap_cmd_t *, int );
- static void imap_list_store_p3( imap_store_t *, imap_list_store_state_t * );
- static void
- imap_list_store( store_t *gctx, int flags,
- void (*cb)( int sts, string_list_t *boxes, void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- imap_store_conf_t *cfg = (imap_store_conf_t *)ctx->gen.conf;
- INIT_REFCOUNTED_STATE(imap_list_store_state_t, sts, cb, aux)
- // ctx->prefix may be empty, "INBOX.", or something else.
- // 'flags' may be LIST_INBOX, LIST_PATH (or LIST_PATH_MAYBE), or both. 'listed'
- // already containing a particular value effectively removes it from 'flags'.
- // This matrix determines what to query, and what comes out as a side effect.
- // The lowercase letters indicate unnecessary results; the queries are done
- // this way to have non-overlapping result sets, so subsequent calls create
- // no duplicates:
- //
- // qry \ pfx | empty | inbox | other
- // ----------+-------+-------+-------
- // inbox | p [I] | I [p] | I
- // both | P [I] | I [P] | I + P
- // path | P [i] | i [P] | P
- //
- int pfx_is_empty = !*ctx->prefix;
- int pfx_is_inbox = !pfx_is_empty && is_inbox( ctx, ctx->prefix, -1 );
- if (((flags & (LIST_PATH | LIST_PATH_MAYBE)) || pfx_is_empty) && !pfx_is_inbox && !(ctx->listed & LIST_PATH)) {
- ctx->listed |= LIST_PATH;
- if (pfx_is_empty)
- ctx->listed |= LIST_INBOX;
- imap_exec( ctx, imap_refcounted_new_cmd( &sts->gen ), imap_list_store_p2,
- "%s \"\" \"%\\s*\"", cfg->use_lsub ? "LSUB" : "LIST", ctx->prefix );
- }
- if (((flags & LIST_INBOX) || pfx_is_inbox) && !pfx_is_empty && !(ctx->listed & LIST_INBOX)) {
- ctx->listed |= LIST_INBOX;
- if (pfx_is_inbox)
- ctx->listed |= LIST_PATH;
- imap_exec( ctx, imap_refcounted_new_cmd( &sts->gen ), imap_list_store_p2,
- "%s \"\" INBOX*", cfg->use_lsub ? "LSUB" : "LIST" );
- }
- imap_list_store_p3( ctx, sts );
- }
- static void
- imap_list_store_p2( imap_store_t *ctx, imap_cmd_t *cmd, int response )
- {
- imap_list_store_state_t *sts = (imap_list_store_state_t *)((imap_cmd_refcounted_t *)cmd)->state;
- transform_refcounted_box_response( &sts->gen, response );
- imap_list_store_p3( ctx, sts );
- }
- static void
- imap_list_store_p3( imap_store_t *ctx, imap_list_store_state_t *sts )
- {
- DONE_REFCOUNTED_STATE_ARGS(sts, , ctx->boxes)
- }
- /******************* imap_cancel_cmds *******************/
- static void
- imap_cancel_cmds( store_t *gctx,
- void (*cb)( void *aux ), void *aux )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- finalize_checked_imap_cmds( ctx, RESP_CANCEL );
- cancel_pending_imap_cmds( ctx );
- if (ctx->in_progress) {
- ctx->canceling = 1;
- ctx->callbacks.imap_cancel = cb;
- ctx->callback_aux = aux;
- } else {
- cb( aux );
- }
- }
- /******************* imap_commit_cmds *******************/
- static void imap_commit_cmds_p2( imap_store_t *, imap_cmd_t *, int );
- static void
- imap_commit_cmds( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- if (ctx->num_wait_check)
- imap_exec( ctx, NULL, imap_commit_cmds_p2, "CHECK" );
- }
- static void
- imap_commit_cmds_p2( imap_store_t *ctx, imap_cmd_t *cmd ATTR_UNUSED, int response )
- {
- finalize_checked_imap_cmds( ctx, response );
- }
- /******************* imap_get_memory_usage *******************/
- static uint
- imap_get_memory_usage( store_t *gctx )
- {
- imap_store_t *ctx = (imap_store_t *)gctx;
- return ctx->buffer_mem + ctx->conn.buffer_mem;
- }
- /******************* imap_get_fail_state *******************/
- static int
- imap_get_fail_state( store_conf_t *gconf )
- {
- return ((imap_store_conf_t *)gconf)->server->failed;
- }
- /******************* imap_parse_store *******************/
- static imap_server_conf_t *servers, **serverapp = &servers;
- static int
- imap_parse_store( conffile_t *cfg, store_conf_t **storep )
- {
- imap_store_conf_t *store;
- imap_server_conf_t *server, *srv, sserver;
- const char *type, *name, *arg;
- unsigned u;
- int acc_opt = 0;
- #ifdef HAVE_LIBSSL
- /* Legacy SSL options */
- int require_ssl = -1, use_imaps = -1;
- int use_tlsv1 = -1, use_tlsv11 = -1, use_tlsv12 = -1, use_tlsv13 = -1;
- #endif
- /* Legacy SASL option */
- int require_cram = -1;
- if (!strcasecmp( "IMAPAccount", cfg->cmd )) {
- server = nfcalloc( sizeof(*server) );
- server->name = nfstrdup( cfg->val );
- *serverapp = server;
- serverapp = &server->next;
- store = NULL;
- *storep = NULL;
- } else if (!strcasecmp( "IMAPStore", cfg->cmd )) {
- store = nfcalloc( sizeof(*store) );
- store->gen.driver = &imap_driver;
- store->gen.name = nfstrdup( cfg->val );
- store->use_namespace = 1;
- *storep = &store->gen;
- memset( &sserver, 0, sizeof(sserver) );
- server = &sserver;
- } else
- return 0;
- server->sconf.timeout = 20;
- #ifdef HAVE_LIBSSL
- server->ssl_type = -1;
- server->sconf.ssl_versions = -1;
- server->sconf.system_certs = 1;
- #endif
- server->max_in_progress = INT_MAX;
- while (getcline( cfg ) && cfg->cmd) {
- if (!strcasecmp( "Host", cfg->cmd )) {
- /* The imap[s]: syntax is just a backwards compat hack. */
- arg = cfg->val;
- #ifdef HAVE_LIBSSL
- if (starts_with( arg, -1, "imaps:", 6 )) {
- arg += 6;
- server->ssl_type = SSL_IMAPS;
- if (server->sconf.ssl_versions == -1)
- server->sconf.ssl_versions = TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3;
- } else
- #endif
- if (starts_with( arg, -1, "imap:", 5 ))
- arg += 5;
- if (starts_with( arg, -1, "//", 2 ))
- arg += 2;
- if (arg != cfg->val)
- warn( "%s:%d: Notice: URL notation is deprecated; use a plain host name and possibly 'SSLType IMAPS' instead\n", cfg->file, cfg->line );
- server->sconf.host = nfstrdup( arg );
- }
- else if (!strcasecmp( "User", cfg->cmd ))
- server->user = nfstrdup( cfg->val );
- else if (!strcasecmp( "UserCmd", cfg->cmd ))
- server->user_cmd = nfstrdup( cfg->val );
- else if (!strcasecmp( "Pass", cfg->cmd ))
- server->pass = nfstrdup( cfg->val );
- else if (!strcasecmp( "PassCmd", cfg->cmd ))
- server->pass_cmd = nfstrdup( cfg->val );
- #ifdef HAVE_MACOS_KEYCHAIN
- else if (!strcasecmp( "UseKeychain", cfg->cmd ))
- server->use_keychain = parse_bool( cfg );
- #endif
- else if (!strcasecmp( "Port", cfg->cmd )) {
- int port = parse_int( cfg );
- if ((unsigned)port > 0xffff) {
- error( "%s:%d: Invalid port number\n", cfg->file, cfg->line );
- cfg->err = 1;
- } else {
- server->sconf.port = (ushort)port;
- }
- } else if (!strcasecmp( "Timeout", cfg->cmd ))
- server->sconf.timeout = parse_int( cfg );
- else if (!strcasecmp( "PipelineDepth", cfg->cmd )) {
- if ((server->max_in_progress = parse_int( cfg )) < 1) {
- error( "%s:%d: PipelineDepth must be at least 1\n", cfg->file, cfg->line );
- cfg->err = 1;
- }
- } else if (!strcasecmp( "DisableExtension", cfg->cmd ) ||
- !strcasecmp( "DisableExtensions", cfg->cmd )) {
- arg = cfg->val;
- do {
- for (u = 0; u < as(cap_list); u++) {
- if (!strcasecmp( cap_list[u], arg )) {
- server->cap_mask |= 1 << u;
- goto gotcap;
- }
- }
- error( "%s:%d: Unrecognized IMAP extension '%s'\n", cfg->file, cfg->line, arg );
- cfg->err = 1;
- gotcap: ;
- } while ((arg = get_arg( cfg, ARG_OPTIONAL, NULL )));
- }
- #ifdef HAVE_LIBSSL
- else if (!strcasecmp( "CertificateFile", cfg->cmd )) {
- server->sconf.cert_file = expand_strdup( cfg->val );
- if (access( server->sconf.cert_file, R_OK )) {
- sys_error( "%s:%d: CertificateFile '%s'",
- cfg->file, cfg->line, server->sconf.cert_file );
- cfg->err = 1;
- }
- } else if (!strcasecmp( "SystemCertificates", cfg->cmd )) {
- server->sconf.system_certs = parse_bool( cfg );
- } else if (!strcasecmp( "ClientCertificate", cfg->cmd )) {
- server->sconf.client_certfile = expand_strdup( cfg->val );
- if (access( server->sconf.client_certfile, R_OK )) {
- sys_error( "%s:%d: ClientCertificate '%s'",
- cfg->file, cfg->line, server->sconf.client_certfile );
- cfg->err = 1;
- }
- } else if (!strcasecmp( "ClientKey", cfg->cmd )) {
- server->sconf.client_keyfile = expand_strdup( cfg->val );
- if (access( server->sconf.client_keyfile, R_OK )) {
- sys_error( "%s:%d: ClientKey '%s'",
- cfg->file, cfg->line, server->sconf.client_keyfile );
- cfg->err = 1;
- }
- } else if (!strcasecmp( "CipherString", cfg->cmd )) {
- server->sconf.cipher_string = nfstrdup( cfg->val );
- } else if (!strcasecmp( "SSLType", cfg->cmd )) {
- if (!strcasecmp( "None", cfg->val )) {
- server->ssl_type = SSL_None;
- } else if (!strcasecmp( "STARTTLS", cfg->val )) {
- server->ssl_type = SSL_STARTTLS;
- } else if (!strcasecmp( "IMAPS", cfg->val )) {
- server->ssl_type = SSL_IMAPS;
- } else {
- error( "%s:%d: Invalid SSL type\n", cfg->file, cfg->line );
- cfg->err = 1;
- }
- } else if (!strcasecmp( "SSLVersion", cfg->cmd ) ||
- !strcasecmp( "SSLVersions", cfg->cmd )) {
- server->sconf.ssl_versions = 0;
- arg = cfg->val;
- do {
- if (!strcasecmp( "SSLv2", arg )) {
- warn( "Warning: SSLVersion SSLv2 is no longer supported\n" );
- } else if (!strcasecmp( "SSLv3", arg )) {
- warn( "Warning: SSLVersion SSLv3 is no longer supported\n" );
- } else if (!strcasecmp( "TLSv1", arg )) {
- server->sconf.ssl_versions |= TLSv1;
- } else if (!strcasecmp( "TLSv1.1", arg )) {
- server->sconf.ssl_versions |= TLSv1_1;
- } else if (!strcasecmp( "TLSv1.2", arg )) {
- server->sconf.ssl_versions |= TLSv1_2;
- } else if (!strcasecmp( "TLSv1.3", arg )) {
- server->sconf.ssl_versions |= TLSv1_3;
- } else {
- error( "%s:%d: Unrecognized SSL version\n", cfg->file, cfg->line );
- cfg->err = 1;
- }
- } while ((arg = get_arg( cfg, ARG_OPTIONAL, NULL )));
- } else if (!strcasecmp( "RequireSSL", cfg->cmd ))
- require_ssl = parse_bool( cfg );
- else if (!strcasecmp( "UseIMAPS", cfg->cmd ))
- use_imaps = parse_bool( cfg );
- else if (!strcasecmp( "UseSSLv2", cfg->cmd ))
- warn( "Warning: UseSSLv2 is no longer supported\n" );
- else if (!strcasecmp( "UseSSLv3", cfg->cmd ))
- warn( "Warning: UseSSLv3 is no longer supported\n" );
- else if (!strcasecmp( "UseTLSv1", cfg->cmd ))
- use_tlsv1 = parse_bool( cfg );
- else if (!strcasecmp( "UseTLSv1.1", cfg->cmd ))
- use_tlsv11 = parse_bool( cfg );
- else if (!strcasecmp( "UseTLSv1.2", cfg->cmd ))
- use_tlsv12 = parse_bool( cfg );
- else if (!strcasecmp( "UseTLSv1.3", cfg->cmd ))
- use_tlsv13 = parse_bool( cfg );
- #endif
- else if (!strcasecmp( "AuthMech", cfg->cmd ) ||
- !strcasecmp( "AuthMechs", cfg->cmd )) {
- arg = cfg->val;
- do
- add_string_list( &server->auth_mechs, arg );
- while ((arg = get_arg( cfg, ARG_OPTIONAL, NULL )));
- } else if (!strcasecmp( "RequireCRAM", cfg->cmd ))
- require_cram = parse_bool( cfg );
- else if (!strcasecmp( "Tunnel", cfg->cmd ))
- server->sconf.tunnel = nfstrdup( cfg->val );
- else if (store) {
- if (!strcasecmp( "Account", cfg->cmd )) {
- for (srv = servers; srv; srv = srv->next)
- if (srv->name && !strcmp( srv->name, cfg->val ))
- goto gotsrv;
- error( "%s:%d: unknown IMAP account '%s'\n", cfg->file, cfg->line, cfg->val );
- cfg->err = 1;
- continue;
- gotsrv:
- store->server = srv;
- } else if (!strcasecmp( "UseNamespace", cfg->cmd ))
- store->use_namespace = parse_bool( cfg );
- else if (!strcasecmp( "SubscribedOnly", cfg->cmd ))
- store->use_lsub = parse_bool( cfg );
- else if (!strcasecmp( "Path", cfg->cmd ))
- store->gen.path = nfstrdup( cfg->val );
- else if (!strcasecmp( "PathDelimiter", cfg->cmd )) {
- if (strlen( cfg->val ) != 1) {
- error( "%s:%d: Path delimiter must be exactly one character long\n", cfg->file, cfg->line );
- cfg->err = 1;
- continue;
- }
- store->delimiter = cfg->val[0];
- } else
- parse_generic_store( &store->gen, cfg, "IMAPStore" );
- continue;
- } else {
- error( "%s:%d: keyword '%s' is not recognized in IMAPAccount sections\n",
- cfg->file, cfg->line, cfg->cmd );
- cfg->err = 1;
- continue;
- }
- acc_opt = 1;
- }
- if (store)
- type = "IMAP store", name = store->gen.name;
- else
- type = "IMAP account", name = server->name;
- if (!store || !store->server) {
- if (!server->sconf.tunnel && !server->sconf.host) {
- error( "%s '%s' has neither Tunnel nor Host\n", type, name );
- cfg->err = 1;
- return 1;
- }
- if (server->user && server->user_cmd) {
- error( "%s '%s' has both User and UserCmd\n", type, name );
- cfg->err = 1;
- return 1;
- }
- if (server->pass && server->pass_cmd) {
- error( "%s '%s' has both Pass and PassCmd\n", type, name );
- cfg->err = 1;
- return 1;
- }
- #ifdef HAVE_MACOS_KEYCHAIN
- if (server->use_keychain && (server->pass || server->pass_cmd)) {
- error( "%s '%s' has UseKeychain enabled despite specifying Pass/PassCmd\n", type, name );
- cfg->err = 1;
- return 1;
- }
- #endif
- #ifdef HAVE_LIBSSL
- if ((use_tlsv1 & use_tlsv11 & use_tlsv12 & use_tlsv13) != -1 || use_imaps >= 0 || require_ssl >= 0) {
- if (server->ssl_type >= 0 || server->sconf.ssl_versions >= 0) {
- error( "%s '%s': The deprecated UseSSL*, UseTLS*, UseIMAPS, and RequireSSL options are mutually exclusive with SSLType and SSLVersions.\n", type, name );
- cfg->err = 1;
- return 1;
- }
- warn( "Notice: %s '%s': UseSSL*, UseTLS*, UseIMAPS, and RequireSSL are deprecated. Use SSLType and SSLVersions instead.\n", type, name );
- server->sconf.ssl_versions =
- (use_tlsv1 == 0 ? 0 : TLSv1) |
- (use_tlsv11 != 1 ? 0 : TLSv1_1) |
- (use_tlsv12 != 1 ? 0 : TLSv1_2) |
- (use_tlsv13 != 1 ? 0 : TLSv1_3);
- if (use_imaps == 1) {
- server->ssl_type = SSL_IMAPS;
- } else if (require_ssl) {
- server->ssl_type = SSL_STARTTLS;
- } else if (!server->sconf.ssl_versions) {
- server->ssl_type = SSL_None;
- } else {
- warn( "Notice: %s '%s': 'RequireSSL no' is being ignored\n", type, name );
- server->ssl_type = SSL_STARTTLS;
- }
- if (server->ssl_type != SSL_None && !server->sconf.ssl_versions) {
- error( "%s '%s' requires SSL but no SSL versions enabled\n", type, name );
- cfg->err = 1;
- return 1;
- }
- } else {
- if (server->sconf.ssl_versions < 0)
- server->sconf.ssl_versions = TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3;
- if (server->ssl_type < 0)
- server->ssl_type = server->sconf.tunnel ? SSL_None : SSL_STARTTLS;
- }
- #endif
- if (require_cram >= 0) {
- if (server->auth_mechs) {
- error( "%s '%s': The deprecated RequireCRAM option is mutually exclusive with AuthMech.\n", type, name );
- cfg->err = 1;
- return 1;
- }
- warn( "Notice: %s '%s': RequireCRAM is deprecated. Use AuthMech instead.\n", type, name );
- if (require_cram)
- add_string_list(&server->auth_mechs, "CRAM-MD5");
- }
- if (!server->auth_mechs)
- add_string_list( &server->auth_mechs, "*" );
- if (!server->sconf.port)
- server->sconf.port =
- #ifdef HAVE_LIBSSL
- server->ssl_type == SSL_IMAPS ? 993 :
- #endif
- 143;
- }
- if (store) {
- if (!store->server) {
- store->server = nfmalloc( sizeof(sserver) );
- memcpy( store->server, &sserver, sizeof(sserver) );
- store->server->name = store->gen.name;
- } else if (acc_opt) {
- error( "%s '%s' has both Account and account-specific options\n", type, name );
- cfg->err = 1;
- }
- }
- return 1;
- }
- static uint
- imap_get_caps( store_t *gctx ATTR_UNUSED )
- {
- return DRV_CRLF | DRV_VERBOSE;
- }
- struct driver imap_driver = {
- imap_get_caps,
- imap_parse_store,
- imap_cleanup,
- imap_alloc_store,
- imap_set_bad_callback,
- imap_connect_store,
- imap_free_store,
- imap_cancel_store,
- imap_list_store,
- imap_select_box,
- imap_get_box_path,
- imap_create_box,
- imap_open_box,
- imap_get_uidnext,
- imap_get_supported_flags,
- imap_confirm_box_empty,
- imap_delete_box,
- imap_finish_delete_box,
- imap_prepare_load_box,
- imap_load_box,
- imap_fetch_msg,
- imap_store_msg,
- imap_find_new_msgs,
- imap_set_msg_flags,
- imap_trash_msg,
- imap_close_box,
- imap_cancel_cmds,
- imap_commit_cmds,
- imap_get_memory_usage,
- imap_get_fail_state,
- };
|