1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601 |
- /*-
- * Copyright 2016 Vsevolod Stakhov
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- #include "lua_common.h"
- #include "message.h"
- #include "protocol.h"
- #include "filter.h"
- #include "dns.h"
- #include "util.h"
- #include "images.h"
- #include "archives.h"
- #include "cfg_file.h"
- #include "email_addr.h"
- #include "utlist.h"
- #include "cryptobox.h"
- #include "unix-std.h"
-
- /***
- * @module rspamd_task
- * This module provides routines for tasks manipulation in rspamd. Tasks usually
- * represent messages being scanned, and this API provides access to such elements
- * as headers, symbols, metrics and so on and so forth. Normally, task objects
- * are passed to the lua callbacks allowing to check specific properties of messages
- * and add the corresponding symbols to the scan's results.
- @example
- rspamd_config.DATE_IN_PAST = function(task)
- if rspamd_config:get_api_version() >= 5 then
- local dm = task:get_date{format = 'message', gmt = true}
- local dt = task:get_date{format = 'connect', gmt = true}
- -- A day
- if dt - dm > 86400 then
- return true
- end
- end
-
- return false
- end
- */
-
- /* Task methods */
- LUA_FUNCTION_DEF (task, get_message);
- LUA_FUNCTION_DEF (task, process_message);
- /***
- * @method task:get_cfg()
- * Get configuration object for a task.
- * @return {rspamd_config} (config.md)[configuration object] for the task
- */
- LUA_FUNCTION_DEF (task, get_cfg);
- LUA_FUNCTION_DEF (task, set_cfg);
- LUA_FUNCTION_DEF (task, destroy);
- /***
- * @method task:get_mempool()
- * Returns memory pool valid for a lifetime of task. It is used internally by
- * many rspamd routines.
- * @return {rspamd_mempool} memory pool object
- */
- LUA_FUNCTION_DEF (task, get_mempool);
- /***
- * @method task:get_session()
- * Returns asynchronous session object that is used by many rspamd asynchronous
- * utilities internally.
- * @return {rspamd_session} session object
- */
- LUA_FUNCTION_DEF (task, get_session);
- /***
- * @method task:get_ev_base()
- * Return asynchronous event base for using in callbacks and resolver.
- * @return {rspamd_ev_base} event base
- */
- LUA_FUNCTION_DEF (task, get_ev_base);
- /***
- * @method task:insert_result(symbol, weigth[, option1, ...])
- * Insert specific symbol to the tasks scanning results assigning the initial
- * weight to it.
- * @param {string} symbol symbol to insert
- * @param {number} weight initial weight (this weight is multiplied by the metric weight)
- * @param {string} options list of optional options attached to a symbol inserted
- @example
- local function cb(task)
- if task:get_header('Some header') then
- task:insert_result('SOME_HEADER', 1.0, 'Got some header')
- end
- end
- */
- LUA_FUNCTION_DEF (task, insert_result);
- /***
- * @method task:set_pre_results(action, description)
- * Sets pre-result for a task. It is used in pre-filters to specify early results
- * of the task scanned. If a pre-filter sets some result, then further processing
- * may be skipped. For selecting action it is possible to use global table
- * `rspamd_actions` or a string value:
- *
- * - `reject`: reject message permanently
- * - `add header`: add spam header
- * - `rewrite subject`: rewrite subject to spam subject
- * - `greylist`: greylist message
- * - `accept` or `no action`: whitelist message
- * @param {rspamd_action or string} action a numeric or string action value
- * @param {string} description optional descripton
- @example
- local function cb(task)
- local gr = task:get_header('Greylist')
- if gr and gr == 'greylist' then
- task:set_pre_result(rspamd_actions['greylist'], 'Greylisting required')
- end
- end
- */
- LUA_FUNCTION_DEF (task, set_pre_result);
- /***
- * @method task:append_message(message)
- * Adds a message to scanning output.
- * @param {string} message
- @example
- local function cb(task)
- task:append_message('Example message')
- end
- */
- LUA_FUNCTION_DEF (task, append_message);
- /***
- * @method task:get_urls([need_emails])
- * Get all URLs found in a message.
- * @param {boolean} need_emails if `true` then reutrn also email urls
- * @return {table rspamd_url} list of all urls found
- @example
- local function phishing_cb(task)
- local urls = task:get_urls();
-
- if urls then
- for _,url in ipairs(urls) do
- if url:is_phished() then
- return true
- end
- end
- end
- return false
- end
- */
- LUA_FUNCTION_DEF (task, get_urls);
- /***
- * @method task:has_urls([need_emails])
- * Returns 'true' if a task has urls listed
- * @param {boolean} need_emails if `true` then reutrn also email urls
- * @return {boolean} true if a task has urls (urls or emails if `need_emails` is true)
- */
- LUA_FUNCTION_DEF (task, has_urls);
- /***
- * @method task:get_content()
- * Get raw content for the specified task
- * @return {text} the data contained in the task
- */
- LUA_FUNCTION_DEF (task, get_content);
-
- /***
- * @method task:get_rawbody()
- * Get raw body for the specified task
- * @return {text} the data contained in the task
- */
- LUA_FUNCTION_DEF (task, get_rawbody);
-
- /***
- * @method task:get_emails()
- * Get all email addresses found in a message.
- * @return {table rspamd_url} list of all email addresses found
- */
- LUA_FUNCTION_DEF (task, get_emails);
- /***
- * @method task:get_text_parts()
- * Get all text (and HTML) parts found in a message
- * @return {table rspamd_text_part} list of text parts
- */
- LUA_FUNCTION_DEF (task, get_text_parts);
- /***
- * @method task:get_parts()
- * Get all mime parts found in a message
- * @return {table rspamd_mime_part} list of mime parts
- */
- LUA_FUNCTION_DEF (task, get_parts);
-
- /***
- * @method task:get_request_header(name)
- * Get value of a HTTP request header.
- * @param {string} name name of header to get
- * @return {rspamd_text} value of an HTTP header
- */
- LUA_FUNCTION_DEF (task, get_request_header);
- /***
- * @method task:set_request_header(name, value)
- * Set value of a HTTP request header. If value is omitted, then a header is removed
- * @param {string} name name of header to get
- * @param {rspamd_text/string} value new header's value
- */
- LUA_FUNCTION_DEF (task, set_request_header);
- /***
- * @method task:get_header(name[, case_sensitive])
- * Get decoded value of a header specified with optional case_sensitive flag.
- * By default headers are searched in caseless matter.
- * @param {string} name name of header to get
- * @param {boolean} case_sensitive case sensitiveness flag to search for a header
- * @return {string} decoded value of a header
- */
- LUA_FUNCTION_DEF (task, get_header);
- /***
- * @method task:get_header_raw(name[, case_sensitive])
- * Get raw value of a header specified with optional case_sensitive flag.
- * By default headers are searched in caseless matter.
- * @param {string} name name of header to get
- * @param {boolean} case_sensitive case sensitiveness flag to search for a header
- * @return {string} raw value of a header
- */
- LUA_FUNCTION_DEF (task, get_header_raw);
- /***
- * @method task:get_header_full(name[, case_sensitive])
- * Get raw value of a header specified with optional case_sensitive flag.
- * By default headers are searched in caseless matter. This method returns more
- * information about the header as a list of tables with the following structure:
- *
- * - `name` - name of a header
- * - `value` - raw value of a header
- * - `decoded` - decoded value of a header
- * - `tab_separated` - `true` if a header and a value are separated by `tab` character
- * - `empty_separator` - `true` if there are no separator between a header and a value
- * @param {string} name name of header to get
- * @param {boolean} case_sensitive case sensitiveness flag to search for a header
- * @return {list of tables} all values of a header as specified above
- @example
- function check_header_delimiter_tab(task, header_name)
- for _,rh in ipairs(task:get_header_full(header_name)) do
- if rh['tab_separated'] then return true end
- end
- return false
- end
- */
- LUA_FUNCTION_DEF (task, get_header_full);
-
- /***
- * @method task:get_raw_headers()
- * Get all undecoded headers of a message as a string
- * @return {rspamd_text} all raw headers for a message as opaque text
- */
- LUA_FUNCTION_DEF (task, get_raw_headers);
-
- /***
- * @method task:get_received_headers()
- * Returns a list of tables of parsed received headers. A tables returned have
- * the following structure:
- *
- * - `from_hostname` - string that represents hostname provided by a peer
- * - `from_ip` - string representation of IP address as provided by a peer
- * - `real_hostname` - hostname as resolved by MTA
- * - `real_ip` - string representation of IP as resolved by PTR request of MTA
- * - `by_hostname` - MTA hostname
- * - `proto` - protocol, e.g. ESMTP or ESMTPS
- * - `timestamp` - received timetamp
- * - `for` - for value (unparsed mailbox)
- *
- * Please note that in some situations rspamd cannot parse all the fields of received headers.
- * In that case you should check all strings for validity.
- * @return {table of tables} list of received headers described above
- */
- LUA_FUNCTION_DEF (task, get_received_headers);
- /***
- * @method task:get_queue_id()
- * Returns queue ID of the message being processed.
- */
- LUA_FUNCTION_DEF (task, get_queue_id);
- /***
- * @method task:get_uid()
- * Returns ID of the task being processed.
- */
- LUA_FUNCTION_DEF (task, get_uid);
- /***
- * @method task:get_resolver()
- * Returns ready to use rspamd_resolver object suitable for making asynchronous DNS requests.
- * @return {rspamd_resolver} resolver object associated with the task's session
- * @example
- local logger = require "rspamd_logger"
-
- local function task_cb(task)
- local function dns_cb(resolver, to_resolve, results, err)
- -- task object is available due to closure
- task:inc_dns_req()
- if results then
- logger.info(string.format('<%s> [%s] resolved for symbol: %s',
- task:get_message_id(), to_resolve, 'EXAMPLE_SYMBOL'))
- task:insert_result('EXAMPLE_SYMBOL', 1)
- end
- end
- local r = task:get_resolver()
- r:resolve_a(task:get_session(), task:get_mempool(), 'example.com', dns_cb)
- end
- */
- LUA_FUNCTION_DEF (task, get_resolver);
- /***
- * @method task:inc_dns_req()
- * Increment number of DNS requests for the task. Is used just for logging purposes.
- */
- LUA_FUNCTION_DEF (task, inc_dns_req);
- /***
- * @method task:get_dns_req()
- * Get number of dns requests being sent in the task
- * @return {number} number of DNS requests
- */
- LUA_FUNCTION_DEF (task, get_dns_req);
-
- /***
- * @method task:has_recipients([type])
- * Return true if there are SMTP or MIME recipients for a task.
- * @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
- * @return {bool} `true` if there are recipients of the following type
- */
- LUA_FUNCTION_DEF (task, has_recipients);
-
- /***
- * @method task:get_recipients([type])
- * Return SMTP or MIME recipients for a task. This function returns list of internet addresses each one is a table with the following structure:
- *
- * - `name` - name of internet address in UTF8, e.g. for `Vsevolod Stakhov <blah@foo.com>` it returns `Vsevolod Stakhov`
- * - `addr` - address part of the address
- * - `user` - user part (if present) of the address, e.g. `blah`
- * - `domain` - domain part (if present), e.g. `foo.com`
- * @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
- * @return {list of addresses} list of recipients or `nil`
- */
- LUA_FUNCTION_DEF (task, get_recipients);
-
- /***
- * @method task:has_from([type])
- * Return true if there is SMTP or MIME sender for a task.
- * @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
- * @return {bool} `true` if there is sender of the following type
- */
- LUA_FUNCTION_DEF (task, has_from);
-
- /***
- * @method task:get_from([type])
- * Return SMTP or MIME sender for a task. This function returns list of internet addresses each one is a table with the following structure:
- *
- * - `name` - name of internet address in UTF8, e.g. for `Vsevolod Stakhov <blah@foo.com>` it returns `Vsevolod Stakhov`
- * - `addr` - address part of the address
- * - `user` - user part (if present) of the address, e.g. `blah`
- * - `domain` - domain part (if present), e.g. `foo.com`
- * @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP sender and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP sender and `2` or `mime` means MIME `From:` only
- * @return {list of addresses} list of recipients or `nil`
- */
- LUA_FUNCTION_DEF (task, get_from);
- /***
- * @method task:get_user()
- * Returns authenticated user name for this task if specified by an MTA.
- * @return {string} username or nil
- */
- LUA_FUNCTION_DEF (task, get_user);
- LUA_FUNCTION_DEF (task, set_user);
- /***
- * @method task:get_from_ip()
- * Returns [ip_addr](ip.md) object of a sender that is provided by MTA
- * @return {rspamd_ip} ip address object
- */
- LUA_FUNCTION_DEF (task, get_from_ip);
- /***
- * @method task:set_from_ip(str)
- * Set tasks's IP address based on the passed string
- * @param {string} str string representation of ip
- */
- LUA_FUNCTION_DEF (task, set_from_ip);
- LUA_FUNCTION_DEF (task, get_from_ip_num);
- /***
- * @method task:get_client_ip()
- * Returns [ip_addr](ip.md) object of a client connected to rspamd (normally, it is an IP address of MTA)
- * @return {rspamd_ip} ip address object
- */
- LUA_FUNCTION_DEF (task, get_client_ip);
- /***
- * @method task:get_helo()
- * Returns the value of SMTP helo provided by MTA.
- * @return {string} HELO value
- */
- LUA_FUNCTION_DEF (task, get_helo);
- LUA_FUNCTION_DEF (task, set_helo);
- /***
- * @method task:get_hostname()
- * Returns the value of sender's hostname provided by MTA
- * @return {string} hostname value
- */
- LUA_FUNCTION_DEF (task, get_hostname);
- LUA_FUNCTION_DEF (task, set_hostname);
- /***
- * @method task:get_images()
- * Returns list of all images found in a task as a table of `rspamd_image`.
- * Each image has the following methods:
- *
- * * `get_width` - return width of an image in pixels
- * * `get_height` - return height of an image in pixels
- * * `get_type` - return string representation of image's type (e.g. 'jpeg')
- * * `get_filename` - return string with image's file name
- * * `get_size` - return size in bytes
- * @return {list of rspamd_image} images found in a message
- */
- LUA_FUNCTION_DEF (task, get_images);
- /***
- * @method task:get_archives()
- * Returns list of all archives found in a task as a table of `rspamd_archive`.
- * Each archive has the following methods available:
- *
- * * `get_files` - return list of strings with filenames inside archive
- * * `get_files_full` - return list of tables with all information about files
- * * `is_encrypted` - return true if an archive is encrypted
- * * `get_type` - return string representation of image's type (e.g. 'zip')
- * * `get_filename` - return string with archive's file name
- * * `get_size` - return size in bytes
- * @return {list of rspamd_archive} archives found in a message
- */
- LUA_FUNCTION_DEF (task, get_archives);
- /***
- * @method task:get_symbol(name)
- * Searches for a symbol `name` in all metrics results and returns a list of tables
- * one per metric that describes the symbol inserted. Please note that this function
- * is intended to return values for **inserted** symbols, so if this symbol was not
- * inserted it won't be in the function's output. This method is useful for post-filters mainly.
- * The symbols are returned as the list of the following tables:
- *
- * - `metric` - name of metric
- * - `score` - score of a symbol in that metric
- * - `options` - a table of strings representing options of a symbol
- * - `group` - a group of symbol (or 'ungrouped')
- * @param {string} name symbol's name
- * @return {list of tables} list of tables or nil if symbol was not found in any metric
- */
- LUA_FUNCTION_DEF (task, get_symbol);
- /***
- * @method task:get_symbols()
- * Returns array of all symbols matched for this task
- * @return {table, table} table of strings with symbols names + table of theirs scores
- */
- LUA_FUNCTION_DEF (task, get_symbols);
-
- /***
- * @method task:get_symbols_numeric()
- * Returns array of all symbols matched for this task
- * @return {table|number, table|number} table of numbers with symbols ids + table of theirs scores
- */
- LUA_FUNCTION_DEF (task, get_symbols_numeric);
-
- /***
- * @method task:has_symbol(name)
- * Fast path to check if a specified symbol is in the task's results
- * @param {string} name symbol's name
- * @return {boolean} `true` if symbol has been found
- */
- LUA_FUNCTION_DEF (task, has_symbol);
- /***
- * @method task:get_date(type[, gmt])
- * Returns timestamp for a connection or for a MIME message. This function can be called with a
- * single table arguments with the following fields:
- *
- * * `format` - a format of date returned:
- * - `message` - returns a mime date as integer (unix timestamp)
- * - `message_str` - returns a mime date as string (UTC format)
- * - `connect` - returns a unix timestamp of a connection to rspamd
- * - `connect_str` - returns connection time in UTC format
- * * `gmt` - returns date in `GMT` timezone (normal for unix timestamps)
- *
- * By default this function returns connection time in numeric format.
- * @param {string} type date format as described above
- * @param {boolean} gmt gmt flag as described above
- * @return {string/number} date representation according to format
- * @example
- rspamd_config.DATE_IN_PAST = function(task)
- local dm = task:get_date{format = 'message', gmt = true}
- local dt = task:get_date{format = 'connect', gmt = true}
- -- A day
- if dt - dm > 86400 then
- return true
- end
-
- return false
- end
- */
- LUA_FUNCTION_DEF (task, get_date);
- /***
- * @method task:get_message_id()
- * Returns message id of the specified task
- * @return {string} if of a message
- */
- LUA_FUNCTION_DEF (task, get_message_id);
- LUA_FUNCTION_DEF (task, get_timeval);
- /***
- * @method task:get_metric_score(name)
- * Get the current score of metric `name`. Should be used in post-filters only.
- * @param {string} name name of a metric
- * @return {table} table containing the current score and required score of the metric
- */
- LUA_FUNCTION_DEF (task, get_metric_score);
- /***
- * @method task:get_metric_action(name)
- * Get the current action of metric `name`. Should be used in post-filters only.
- * @param {string} name name of a metric
- * @return {string} the current action of the metric as a string
- */
- LUA_FUNCTION_DEF (task, get_metric_action);
- /***
- * @method task:set_metric_score(name, score)
- * Set the current score of metric `name`. Should be used in post-filters only.
- * @param {string} name name of a metric
- * @param {number} score the current score of the metric
- */
- LUA_FUNCTION_DEF (task, set_metric_score);
- /***
- * @method task:set_metric_action(name, action)
- * Set the current action of metric `name`. Should be used in post-filters only.
- * @param {string} name name of a metric
- * @param {string} action name to set
- */
- LUA_FUNCTION_DEF (task, set_metric_action);
-
- /***
- * @method task:learn(is_spam[, classifier)
- * Learn classifier `classifier` with the task. If `is_spam` is true then message
- * is learnt as spam. Otherwise HAM is learnt. By default, this function learns
- * `bayes` classifier.
- * @param {boolean} is_spam learn spam or ham
- * @param {string} classifier classifier's name
- * @return {boolean} `true` if classifier has been learnt successfully
- */
- LUA_FUNCTION_DEF (task, learn);
- /***
- * @method task:set_settings(obj)
- * Set users settings object for a task. The format of this object is described
- * [here](https://rspamd.com/doc/configuration/settings.html).
- * @param {any} obj any lua object that corresponds to the settings format
- */
- LUA_FUNCTION_DEF (task, set_settings);
-
- /***
- * @method task:get_settings()
- * Gets users settings object for a task. The format of this object is described
- * [here](https://rspamd.com/doc/configuration/settings.html).
- * @return {lua object} lua object generated from UCL
- */
- LUA_FUNCTION_DEF (task, get_settings);
-
- /***
- * @method task:lookup_settings(key)
- * Gets users settings object with the specified key for a task.
- * @param {string} key key to lookup
- * @return {lua object} lua object generated from UCL
- */
- LUA_FUNCTION_DEF (task, lookup_settings);
-
- /***
- * @method task:get_settings_id()
- * Get numeric hash of settings id if specified for this task. 0 is returned otherwise.
- * @return {number} settings-id hash
- */
- LUA_FUNCTION_DEF (task, get_settings_id);
-
- /***
- * @method task:set_rmilter_reply(obj)
- * Set special reply for rmilter
- * @param {any} obj any lua object that corresponds to the settings format
- * @example
- task:set_rmilter_reply({
- add_headers = {['X-Lua'] = 'test'},
- -- 1 is the position of header to remove
- remove_headers = {['DKIM-Signature'] = 1},
- })
- */
- LUA_FUNCTION_DEF (task, set_rmilter_reply);
-
- /***
- * @method task:process_re(params)
- * Processes the specified regexp and returns number of captures (cached or new)
- * Params is the table with the follwoing fields (mandatory fields are marked with `*`):
- * - `re`* : regular expression object
- * - `type`*: type of regular expression:
- * + `mime`: mime regexp
- * + `header`: header regexp
- * + `rawheader`: raw header expression
- * + `rawmime`: raw mime regexp
- * + `body`: raw body regexp
- * + `url`: url regexp
- * - `header`: for header and rawheader regexp means the name of header
- * - `strong`: case sensitive match for headers
- * @return {number} number of regexp occurences in the task (limited by 255 so far)
- */
- LUA_FUNCTION_DEF (task, process_regexp);
-
- /*
- * Deprecated functions!
- */
- LUA_FUNCTION_DEF (task, cache_set);
-
- LUA_FUNCTION_DEF (task, cache_get);
-
- /***
- * @method task:get_size()
- * Returns size of the task in bytes (that includes headers + parts size)
- * @return {number} size in bytes
- */
- LUA_FUNCTION_DEF (task, get_size);
-
- /***
- * @method task:set_flag(flag_name[, set])
- * Set specific flag for task:
- *
- * - `no_log`: do not log task summary
- * - `no_stat`: do not include task into scanned stats
- * - `pass_all`: check all filters for task
- * - `extended_urls`: output extended info about urls
- * - `skip`: skip task processing
- * - `learn_spam`: learn message as spam
- * - `learn_ham`: learn message as ham
- * - `broken_headers`: header data is broken for a message
- * @param {string} flag to set
- * @param {boolean} set set or clear flag (default is set)
- @example
- --[[
- For messages with undefined queue ID (scanned with rspamc or WebUI)
- do not include results into statistics and do not log task summary
- (it will not appear in the WebUI history as well).
- ]]--
-
- -- Callback function to set flags
- local function no_log_stat_cb(task)
- if not task:get_queue_id() then
- task:set_flag('no_log')
- task:set_flag('no_stat')
- end
- end
-
- rspamd_config:register_symbol({
- name = 'LOCAL_NO_LOG_STAT',
- type = 'postfilter',
- callback = no_log_stat_cb
- })
- */
- LUA_FUNCTION_DEF (task, set_flag);
-
-
- /***
- * @method task:has_flag(flag_name)
- * Checks for a specific flag in task:
- *
- * - `no_log`: do not log task summary
- * - `no_stat`: do not include task into scanned stats
- * - `pass_all`: check all filters for task
- * - `extended_urls`: output extended info about urls
- * - `skip`: skip task processing
- * - `learn_spam`: learn message as spam
- * - `learn_ham`: learn message as ham
- * - `broken_headers`: header data is broken for a message
- * @param {string} flag to check
- * @return {boolean} true if flags is set
- */
- LUA_FUNCTION_DEF (task, has_flag);
-
-
- /***
- * @method task:get_flags()
- * Get list of flags for task:
- *
- * - `no_log`: do not log task summary
- * - `no_stat`: do not include task into scanned stats
- * - `pass_all`: check all filters for task
- * - `extended_urls`: output extended info about urls
- * - `skip`: skip task processing
- * - `learn_spam`: learn message as spam
- * - `learn_ham`: learn message as ham
- * - `broken_headers`: header data is broken for a message
- * @return {array of strings} table with all flags as strings
- */
- LUA_FUNCTION_DEF (task, get_flags);
-
- /***
- * @method task:get_digest()
- * Returns message's unique digest (32 hex symbols)
- * @return {string} hex digest
- */
- LUA_FUNCTION_DEF (task, get_digest);
-
- static const struct luaL_reg tasklib_f[] = {
- {NULL, NULL}
- };
-
- static const struct luaL_reg tasklib_m[] = {
- LUA_INTERFACE_DEF (task, get_message),
- LUA_INTERFACE_DEF (task, destroy),
- LUA_INTERFACE_DEF (task, process_message),
- LUA_INTERFACE_DEF (task, set_cfg),
- LUA_INTERFACE_DEF (task, get_cfg),
- LUA_INTERFACE_DEF (task, get_mempool),
- LUA_INTERFACE_DEF (task, get_session),
- LUA_INTERFACE_DEF (task, get_ev_base),
- LUA_INTERFACE_DEF (task, insert_result),
- LUA_INTERFACE_DEF (task, set_pre_result),
- LUA_INTERFACE_DEF (task, append_message),
- LUA_INTERFACE_DEF (task, has_urls),
- LUA_INTERFACE_DEF (task, get_urls),
- LUA_INTERFACE_DEF (task, get_content),
- LUA_INTERFACE_DEF (task, get_rawbody),
- LUA_INTERFACE_DEF (task, get_emails),
- LUA_INTERFACE_DEF (task, get_text_parts),
- LUA_INTERFACE_DEF (task, get_parts),
- LUA_INTERFACE_DEF (task, get_request_header),
- LUA_INTERFACE_DEF (task, set_request_header),
- LUA_INTERFACE_DEF (task, get_header),
- LUA_INTERFACE_DEF (task, get_header_raw),
- LUA_INTERFACE_DEF (task, get_header_full),
- LUA_INTERFACE_DEF (task, get_raw_headers),
- LUA_INTERFACE_DEF (task, get_received_headers),
- LUA_INTERFACE_DEF (task, get_queue_id),
- LUA_INTERFACE_DEF (task, get_uid),
- LUA_INTERFACE_DEF (task, get_resolver),
- LUA_INTERFACE_DEF (task, inc_dns_req),
- LUA_INTERFACE_DEF (task, get_dns_req),
- LUA_INTERFACE_DEF (task, has_recipients),
- LUA_INTERFACE_DEF (task, get_recipients),
- LUA_INTERFACE_DEF (task, has_from),
- LUA_INTERFACE_DEF (task, get_from),
- LUA_INTERFACE_DEF (task, get_user),
- LUA_INTERFACE_DEF (task, set_user),
- {"get_addr", lua_task_get_from_ip},
- {"get_ip", lua_task_get_from_ip},
- {"get_from_addr", lua_task_get_from_ip},
- LUA_INTERFACE_DEF (task, get_from_ip),
- LUA_INTERFACE_DEF (task, set_from_ip),
- LUA_INTERFACE_DEF (task, get_from_ip_num),
- LUA_INTERFACE_DEF (task, get_client_ip),
- LUA_INTERFACE_DEF (task, get_helo),
- LUA_INTERFACE_DEF (task, set_helo),
- LUA_INTERFACE_DEF (task, get_hostname),
- LUA_INTERFACE_DEF (task, set_hostname),
- LUA_INTERFACE_DEF (task, get_images),
- LUA_INTERFACE_DEF (task, get_archives),
- LUA_INTERFACE_DEF (task, get_symbol),
- LUA_INTERFACE_DEF (task, get_symbols),
- LUA_INTERFACE_DEF (task, get_symbols_numeric),
- LUA_INTERFACE_DEF (task, has_symbol),
- LUA_INTERFACE_DEF (task, get_date),
- LUA_INTERFACE_DEF (task, get_message_id),
- LUA_INTERFACE_DEF (task, get_timeval),
- LUA_INTERFACE_DEF (task, get_metric_score),
- LUA_INTERFACE_DEF (task, get_metric_action),
- LUA_INTERFACE_DEF (task, set_metric_score),
- LUA_INTERFACE_DEF (task, set_metric_action),
- LUA_INTERFACE_DEF (task, learn),
- LUA_INTERFACE_DEF (task, set_settings),
- LUA_INTERFACE_DEF (task, get_settings),
- LUA_INTERFACE_DEF (task, lookup_settings),
- LUA_INTERFACE_DEF (task, get_settings_id),
- LUA_INTERFACE_DEF (task, cache_get),
- LUA_INTERFACE_DEF (task, cache_set),
- LUA_INTERFACE_DEF (task, process_regexp),
- LUA_INTERFACE_DEF (task, get_size),
- LUA_INTERFACE_DEF (task, set_flag),
- LUA_INTERFACE_DEF (task, get_flags),
- LUA_INTERFACE_DEF (task, has_flag),
- LUA_INTERFACE_DEF (task, set_rmilter_reply),
- LUA_INTERFACE_DEF (task, get_digest),
- {"__tostring", rspamd_lua_class_tostring},
- {NULL, NULL}
- };
-
- /* Image methods */
- LUA_FUNCTION_DEF (image, get_width);
- LUA_FUNCTION_DEF (image, get_height);
- LUA_FUNCTION_DEF (image, get_type);
- LUA_FUNCTION_DEF (image, get_filename);
- LUA_FUNCTION_DEF (image, get_size);
-
- static const struct luaL_reg imagelib_m[] = {
- LUA_INTERFACE_DEF (image, get_width),
- LUA_INTERFACE_DEF (image, get_height),
- LUA_INTERFACE_DEF (image, get_type),
- LUA_INTERFACE_DEF (image, get_filename),
- LUA_INTERFACE_DEF (image, get_size),
- {"__tostring", rspamd_lua_class_tostring},
- {NULL, NULL}
- };
-
- /* Archive methods */
- LUA_FUNCTION_DEF (archive, get_type);
- LUA_FUNCTION_DEF (archive, get_files);
- LUA_FUNCTION_DEF (archive, get_files_full);
- LUA_FUNCTION_DEF (archive, is_encrypted);
- LUA_FUNCTION_DEF (archive, get_filename);
- LUA_FUNCTION_DEF (archive, get_size);
-
- static const struct luaL_reg archivelib_m[] = {
- LUA_INTERFACE_DEF (archive, get_type),
- LUA_INTERFACE_DEF (archive, get_files),
- LUA_INTERFACE_DEF (archive, get_files_full),
- LUA_INTERFACE_DEF (archive, is_encrypted),
- LUA_INTERFACE_DEF (archive, get_filename),
- LUA_INTERFACE_DEF (archive, get_size),
- {"__tostring", rspamd_lua_class_tostring},
- {NULL, NULL}
- };
-
- /* Blob methods */
- LUA_FUNCTION_DEF (text, len);
- LUA_FUNCTION_DEF (text, str);
- LUA_FUNCTION_DEF (text, ptr);
- LUA_FUNCTION_DEF (text, gc);
-
- static const struct luaL_reg textlib_m[] = {
- LUA_INTERFACE_DEF (text, len),
- LUA_INTERFACE_DEF (text, str),
- LUA_INTERFACE_DEF (text, ptr),
- {"__len", lua_text_len},
- {"__tostring", lua_text_str},
- {"__gc", lua_text_gc},
- {NULL, NULL}
- };
-
- /* Utility functions */
- struct rspamd_task *
- lua_check_task (lua_State * L, gint pos)
- {
- void *ud = rspamd_lua_check_udata (L, pos, "rspamd{task}");
- luaL_argcheck (L, ud != NULL, pos, "'task' expected");
- return ud ? *((struct rspamd_task **)ud) : NULL;
- }
-
- struct rspamd_task *
- lua_check_task_maybe (lua_State * L, gint pos)
- {
- void *ud = rspamd_lua_check_udata_maybe (L, pos, "rspamd{task}");
-
- return ud ? *((struct rspamd_task **)ud) : NULL;
- }
-
- static struct rspamd_image *
- lua_check_image (lua_State * L)
- {
- void *ud = rspamd_lua_check_udata (L, 1, "rspamd{image}");
- luaL_argcheck (L, ud != NULL, 1, "'image' expected");
- return ud ? *((struct rspamd_image **)ud) : NULL;
- }
-
- static struct rspamd_archive *
- lua_check_archive (lua_State * L)
- {
- void *ud = rspamd_lua_check_udata (L, 1, "rspamd{archive}");
- luaL_argcheck (L, ud != NULL, 1, "'archive' expected");
- return ud ? *((struct rspamd_archive **)ud) : NULL;
- }
-
- struct rspamd_lua_text *
- lua_check_text (lua_State * L, gint pos)
- {
- void *ud = rspamd_lua_check_udata (L, pos, "rspamd{text}");
- luaL_argcheck (L, ud != NULL, pos, "'text' expected");
- return ud ? (struct rspamd_lua_text *)ud : NULL;
- }
-
- /* Task methods */
- static int
- lua_task_process_message (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- if (task->msg.len > 0) {
- if (rspamd_message_parse (task) == 0) {
- lua_pushboolean (L, TRUE);
- }
- else {
- lua_pushboolean (L, FALSE);
- }
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static int
- lua_task_get_cfg (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_config **pcfg;
-
- if (task) {
- pcfg = lua_newuserdata (L, sizeof (gpointer));
- rspamd_lua_setclass (L, "rspamd{config}", -1);
- *pcfg = task->cfg;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static int
- lua_task_set_cfg (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- void *ud = rspamd_lua_check_udata (L, 2, "rspamd{config}");
-
- if (task) {
- luaL_argcheck (L, ud != NULL, 1, "'config' expected");
- task->cfg = ud ? *((struct rspamd_config **)ud) : NULL;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static int
- lua_task_destroy (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- rspamd_task_free (task);
- }
-
- return 0;
- }
-
- static int
- lua_task_get_message (lua_State * L)
- {
- GMimeMessage **pmsg;
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- if (task->message != NULL) {
- pmsg = lua_newuserdata (L, sizeof (GMimeMessage *));
- rspamd_lua_setclass (L, "rspamd{message}", -1);
- *pmsg = task->message;
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
- return 1;
- }
-
- static int
- lua_task_get_mempool (lua_State * L)
- {
- rspamd_mempool_t **ppool;
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- ppool = lua_newuserdata (L, sizeof (rspamd_mempool_t *));
- rspamd_lua_setclass (L, "rspamd{mempool}", -1);
- *ppool = task->task_pool;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static int
- lua_task_get_session (lua_State * L)
- {
- struct rspamd_async_session **psession;
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- psession = lua_newuserdata (L, sizeof (void *));
- rspamd_lua_setclass (L, "rspamd{session}", -1);
- *psession = task->s;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
- return 1;
- }
-
- static int
- lua_task_get_ev_base (lua_State * L)
- {
- struct event_base **pbase;
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- pbase = lua_newuserdata (L, sizeof (struct event_base *));
- rspamd_lua_setclass (L, "rspamd{ev_base}", -1);
- *pbase = task->ev_base;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
- return 1;
- }
-
- static gint
- lua_task_insert_result (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *symbol_name, *param;
- double flag;
- GList *params = NULL;
- gint i, top;
-
- if (task != NULL) {
- symbol_name =
- rspamd_mempool_strdup (task->task_pool, luaL_checkstring (L, 2));
- flag = luaL_checknumber (L, 3);
- top = lua_gettop (L);
- /* Get additional options */
- for (i = 4; i <= top; i++) {
- if (lua_type (L, i) == LUA_TSTRING) {
- param = luaL_checkstring (L, i);
- params =
- g_list_prepend (params,
- rspamd_mempool_strdup (task->task_pool, param));
- }
- else if (lua_type (L, i) == LUA_TTABLE) {
- lua_pushvalue (L, i);
- lua_pushnil (L);
-
- while (lua_next (L, -2)) {
- param = lua_tostring (L, -1);
- params = g_list_prepend (params,
- rspamd_mempool_strdup (task->task_pool,
- param));
- lua_pop (L, 1);
- }
-
- lua_pop (L, 1);
- }
- }
-
- if (params) {
- params = g_list_reverse (params);
- }
-
- rspamd_task_insert_result (task, symbol_name, flag, params);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_set_pre_result (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct metric_result *mres;
- gchar *action_str;
- gint action = METRIC_ACTION_MAX;
-
- if (task != NULL) {
- if (lua_type (L, 2) == LUA_TNUMBER) {
- action = lua_tointeger (L, 2);
- }
- else if (lua_type (L, 2) == LUA_TSTRING) {
- rspamd_action_from_str (lua_tostring (L, 2), &action);
- }
-
- if (action < METRIC_ACTION_MAX && action >= METRIC_ACTION_REJECT) {
- /* We also need to set the default metric to that result */
- mres = rspamd_create_metric_result (task, DEFAULT_METRIC);
- if (mres != NULL) {
- mres->score = mres->metric->actions[action].score;
- mres->action = action;
- }
-
- task->pre_result.action = action;
-
- if (lua_gettop (L) >= 3) {
- action_str = rspamd_mempool_strdup (task->task_pool,
- luaL_checkstring (L, 3));
- task->pre_result.str = action_str;
- task->messages = g_list_prepend (task->messages, action_str);
- }
- else {
- task->pre_result.str = "unknown";
- }
- msg_info_task ("<%s>: set pre-result to %s: '%s'",
- task->message_id, rspamd_action_to_str (action),
- task->pre_result.str);
-
- /* Don't classify or filter message if pre-filter sets results */
- task->processed_stages |= (RSPAMD_TASK_STAGE_FILTERS |
- RSPAMD_TASK_STAGE_CLASSIFIERS |
- RSPAMD_TASK_STAGE_CLASSIFIERS_PRE |
- RSPAMD_TASK_STAGE_CLASSIFIERS_POST);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_append_message (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gchar *message;
-
- if (task != NULL) {
- message= rspamd_mempool_strdup (task->task_pool,
- luaL_checkstring (L, 2));
- task->messages = g_list_prepend (task->messages, message);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- struct lua_tree_cb_data {
- lua_State *L;
- int i;
- };
-
- static void
- lua_tree_url_callback (gpointer key, gpointer value, gpointer ud)
- {
- struct rspamd_lua_url *url;
- struct lua_tree_cb_data *cb = ud;
-
- url = lua_newuserdata (cb->L, sizeof (struct rspamd_lua_url));
- rspamd_lua_setclass (cb->L, "rspamd{url}", -1);
- url->url = value;
- lua_rawseti (cb->L, -2, cb->i++);
- }
-
- static gint
- lua_task_get_urls (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct lua_tree_cb_data cb;
- gboolean need_emails = FALSE;
- gsize sz;
-
- if (task) {
- if (lua_gettop (L) >= 2) {
- need_emails = lua_toboolean (L, 2);
- }
-
- sz = g_hash_table_size (task->urls);
-
- if (need_emails) {
- sz += g_hash_table_size (task->emails);
- }
-
- lua_createtable (L, sz, 0);
- cb.i = 1;
- cb.L = L;
- g_hash_table_foreach (task->urls, lua_tree_url_callback, &cb);
-
- if (need_emails) {
- g_hash_table_foreach (task->emails, lua_tree_url_callback, &cb);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_has_urls (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gboolean need_emails = FALSE, ret = FALSE;
-
- if (task) {
- if (lua_gettop (L) >= 2) {
- need_emails = lua_toboolean (L, 2);
- }
-
- if (g_hash_table_size (task->urls) > 0) {
- ret = TRUE;
- }
-
- if (need_emails && g_hash_table_size (task->emails) > 0) {
- ret = TRUE;
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- lua_pushboolean (L, ret);
-
- return 1;
- }
-
- static gint
- lua_task_get_content (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_lua_text *t;
-
- if (task) {
- t = lua_newuserdata (L, sizeof (*t));
- rspamd_lua_setclass (L, "rspamd{text}", -1);
- t->len = task->msg.len;
- t->start = task->msg.begin;
- t->flags = 0;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_rawbody (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_lua_text *t;
-
- if (task) {
- t = lua_newuserdata (L, sizeof (*t));
- rspamd_lua_setclass (L, "rspamd{text}", -1);
-
- if (task->raw_headers_content.len > 0) {
- g_assert (task->raw_headers_content.len <= task->msg.len);
- t->start = task->msg.begin + task->raw_headers_content.len;
- t->len = task->msg.len - task->raw_headers_content.len;
- }
- else {
- t->len = task->msg.len;
- t->start = task->msg.begin;
- }
-
- t->flags = 0;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_emails (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct lua_tree_cb_data cb;
-
- if (task) {
- lua_createtable (L, g_hash_table_size (task->emails), 0);
- cb.i = 1;
- cb.L = L;
- g_hash_table_foreach (task->emails, lua_tree_url_callback, &cb);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_text_parts (lua_State * L)
- {
- guint i;
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_mime_text_part *part, **ppart;
-
- if (task != NULL) {
- lua_createtable (L, task->text_parts->len, 0);
-
- for (i = 0; i < task->text_parts->len; i ++) {
- part = g_ptr_array_index (task->text_parts, i);
- ppart = lua_newuserdata (L, sizeof (struct rspamd_mime_text_part *));
- *ppart = part;
- rspamd_lua_setclass (L, "rspamd{textpart}", -1);
- /* Make it array */
- lua_rawseti (L, -2, i + 1);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_parts (lua_State * L)
- {
- guint i;
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_mime_part *part, **ppart;
-
- if (task != NULL) {
- lua_createtable (L, task->parts->len, 0);
-
- for (i = 0; i < task->parts->len; i ++) {
- part = g_ptr_array_index (task->parts, i);
- ppart = lua_newuserdata (L, sizeof (struct rspamd_mime_part *));
- *ppart = part;
- rspamd_lua_setclass (L, "rspamd{mimepart}", -1);
- /* Make it array */
- lua_rawseti (L, -2, i + 1);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_request_header (lua_State *L)
- {
- rspamd_ftok_t *hdr;
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *s;
- struct rspamd_lua_text *t;
-
- s = luaL_checkstring (L, 2);
-
- if (s && task) {
- hdr = rspamd_task_get_request_header (task, s);
-
- if (hdr) {
- t = lua_newuserdata (L, sizeof (*t));
- rspamd_lua_setclass (L, "rspamd{text}", -1);
- t->start = hdr->begin;
- t->len = hdr->len;
- t->flags = 0;
-
- return 1;
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_request_header (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *s, *v = NULL;
- rspamd_fstring_t *buf;
- struct rspamd_lua_text *t;
- rspamd_ftok_t *hdr, *new_name;
- gsize len, vlen;
-
- s = luaL_checklstring (L, 2, &len);
-
- if (s && task) {
- if (lua_type (L, 3) == LUA_TSTRING) {
- v = luaL_checklstring (L, 2, &vlen);
- }
- else if (lua_type (L, 3) == LUA_TUSERDATA) {
- t = lua_check_text (L, 3);
-
- if (t != NULL) {
- v = t->start;
- vlen = t->len;
- }
- }
-
- if (v != NULL) {
- buf = rspamd_fstring_new_init (v, vlen);
- hdr = rspamd_ftok_map (buf);
- buf = rspamd_fstring_new_init (s, len);
- new_name = rspamd_ftok_map (buf);
-
- rspamd_task_add_request_header (task, new_name, hdr);
- }
-
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
-
- return 0;
- }
-
- gint
- rspamd_lua_push_header (lua_State * L,
- GPtrArray *ar,
- const gchar *name,
- gboolean strong,
- gboolean full,
- gboolean raw)
- {
-
- struct raw_header *rh;
- guint i;
- const gchar *val;
-
- if (ar == NULL || ar->len == 0) {
- lua_pushnil (L);
- return 1;
- }
-
- if (full) {
- lua_createtable (L, ar->len, 0);
- }
-
- PTR_ARRAY_FOREACH (ar, i, rh) {
- if (full) {
- /* Create new associated table for a header */
- lua_createtable (L, 0, 6);
- rspamd_lua_table_set (L, "name", rh->name);
-
- if (rh->value) {
- rspamd_lua_table_set (L, "value", rh->value);
- }
-
- if (rh->decoded) {
- rspamd_lua_table_set (L, "decoded", rh->value);
- }
-
- lua_pushstring (L, "tab_separated");
- lua_pushboolean (L, rh->tab_separated);
- lua_settable (L, -3);
- lua_pushstring (L, "empty_separator");
- lua_pushboolean (L, rh->empty_separator);
- lua_settable (L, -3);
- rspamd_lua_table_set (L, "separator", rh->separator);
- lua_rawseti (L, -2, i + 1);
- }
- else {
- if (!raw) {
- val = rh->decoded;
- }
- else {
- val = rh->value;
- }
-
- if (val) {
- lua_pushstring (L, val);
- }
- else {
- lua_pushnil (L);
- }
-
- return 1;
- }
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_header_common (lua_State *L, gboolean full, gboolean raw)
- {
- gboolean strong = FALSE;
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *name;
- GPtrArray *ar;
-
- name = luaL_checkstring (L, 2);
-
- if (name && task) {
- if (lua_gettop (L) == 3) {
- strong = lua_toboolean (L, 3);
- }
-
- ar = rspamd_message_get_header_array (task, name, strong);
-
- return rspamd_lua_push_header (L, ar, name,
- strong, full, raw);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
- }
-
- static gint
- lua_task_get_header_full (lua_State * L)
- {
- return lua_task_get_header_common (L, TRUE, TRUE);
- }
-
- static gint
- lua_task_get_header (lua_State * L)
- {
- return lua_task_get_header_common (L, FALSE, FALSE);
- }
-
- static gint
- lua_task_get_header_raw (lua_State * L)
- {
- return lua_task_get_header_common (L, FALSE, TRUE);
- }
-
- static gint
- lua_task_get_raw_headers (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_lua_text *t;
-
- if (task) {
- t = lua_newuserdata (L, sizeof (*t));
- rspamd_lua_setclass (L, "rspamd{text}", -1);
- t->start = task->raw_headers_content.begin;
- t->len = task->raw_headers_content.len;
- t->flags = 0;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
-
- return 1;
- }
-
- static gint
- lua_task_get_received_headers (lua_State * L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct received_header *rh;
- const gchar *proto;
- guint i, k = 1;
-
- if (task) {
- lua_createtable (L, task->received->len, 0);
-
- for (i = 0; i < task->received->len; i ++) {
- rh = g_ptr_array_index (task->received, i);
-
- if (G_UNLIKELY (rh->from_ip == NULL &&
- rh->real_ip == NULL &&
- rh->real_hostname == NULL &&
- rh->by_hostname == NULL && rh->timestamp == 0 &&
- rh->for_mbox == NULL)) {
- continue;
- }
-
- lua_createtable (L, 0, 8);
- rspamd_lua_table_set (L, "from_hostname", rh->from_hostname);
- rspamd_lua_table_set (L, "from_ip", rh->from_ip);
- rspamd_lua_table_set (L, "real_hostname", rh->real_hostname);
- lua_pushstring (L, "real_ip");
- rspamd_lua_ip_push (L, rh->addr);
- lua_settable (L, -3);
- lua_pushstring (L, "proto");
-
- switch (rh->type) {
- case RSPAMD_RECEIVED_SMTP:
- proto = "smtp";
- break;
- case RSPAMD_RECEIVED_ESMTP:
- proto = "esmtp";
- break;
- case RSPAMD_RECEIVED_ESMTPS:
- proto = "esmtps";
- break;
- case RSPAMD_RECEIVED_ESMTPA:
- proto = "esmtpa";
- break;
- case RSPAMD_RECEIVED_ESMTPSA:
- proto = "esmtpsa";
- break;
- case RSPAMD_RECEIVED_LMTP:
- proto = "lmtp";
- break;
- case RSPAMD_RECEIVED_IMAP:
- proto = "imap";
- break;
- case RSPAMD_RECEIVED_UNKNOWN:
- default:
- proto = "unknown";
- break;
- }
- lua_pushstring (L, proto);
- lua_settable (L, -3);
-
- lua_pushstring (L, "timestamp");
- lua_pushnumber (L, rh->timestamp);
- lua_settable (L, -3);
-
- rspamd_lua_table_set (L, "by_hostname", rh->by_hostname);
- rspamd_lua_table_set (L, "for", rh->for_mbox);
- lua_rawseti (L, -2, k ++);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_queue_id (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- if (task->queue_id != NULL && strcmp (task->queue_id, "undef") != 0) {
- lua_pushstring (L, task->queue_id);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_uid (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- lua_pushstring (L, task->task_pool->tag.uid);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_resolver (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_dns_resolver **presolver;
-
- if (task != NULL && task->resolver != NULL) {
- presolver = lua_newuserdata (L, sizeof (void *));
- rspamd_lua_setclass (L, "rspamd{resolver}", -1);
- *presolver = task->resolver;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_inc_dns_req (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- task->dns_requests++;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_get_dns_req (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- lua_pushnumber (L, task->dns_requests);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- enum rspamd_address_type {
- RSPAMD_ADDRESS_ANY = 0,
- RSPAMD_ADDRESS_SMTP = 1,
- RSPAMD_ADDRESS_MIME = 2,
- RSPAMD_ADDRESS_RAW_ANY = 3,
- RSPAMD_ADDRESS_RAW_SMTP = 4,
- RSPAMD_ADDRESS_RAW_MIME = 5,
- RSPAMD_ADDRESS_MAX
- };
-
- /*
- * Convert element at the specified position to the type
- * for get_from/get_recipients
- */
- static enum rspamd_address_type
- lua_task_str_to_get_type (lua_State *L, gint pos)
- {
- const gchar *type = NULL;
- gint ret = RSPAMD_ADDRESS_ANY;
- guint64 h;
- gsize sz;
-
- /* Get what value */
-
- if (lua_type (L, pos) == LUA_TNUMBER) {
- ret = lua_tonumber (L, pos);
-
- if (ret >= RSPAMD_ADDRESS_ANY && ret < RSPAMD_ADDRESS_MAX) {
- return ret;
- }
-
- return RSPAMD_ADDRESS_ANY;
- }
- else if (lua_type (L, pos) == LUA_TSTRING) {
- type = lua_tolstring (L, pos, &sz);
-
- if (type && sz > 0) {
- h = rspamd_cryptobox_fast_hash_specific (RSPAMD_CRYPTOBOX_XXHASH64,
- type, sz, 0xdeadbabe);
-
- switch (h) {
- case 0xDA081341FB600389ULL: /* mime */
- ret = RSPAMD_ADDRESS_MIME;
- break;
- case 0xEEC8A7832F8C43ACULL: /* any */
- ret = RSPAMD_ADDRESS_ANY;
- break;
- case 0x472274D5193B2A80ULL: /* smtp */
- case 0xEFE0F586CC9F14A9ULL: /* envelope */
- ret = RSPAMD_ADDRESS_SMTP;
- break;
- case 0x9DA887501690DE20ULL: /* raw_mime */
- ret = RSPAMD_ADDRESS_RAW_MIME;
- break;
- case 0x6B54FE02DEB595A4ULL: /* raw_smtp */
- case 0xE0E596C861777B02ULL: /* raw_envelope */
- ret = RSPAMD_ADDRESS_RAW_SMTP;
- break;
- case 0x2C49DBE3A10A0197ULL: /* raw_any */
- ret = RSPAMD_ADDRESS_RAW_ANY;
- break;
- }
- }
- }
-
- return ret;
- }
-
- static void
- lua_push_email_address (lua_State *L, struct rspamd_email_address *addr)
- {
- if (addr) {
- lua_createtable (L, 0, 3);
-
- if (addr->addr_len > 0) {
- lua_pushstring (L, "addr");
- lua_pushlstring (L, addr->addr, addr->addr_len);
- lua_settable (L, -3);
- }
- else {
- lua_pushstring (L, "addr");
- lua_pushstring (L, "");
- lua_settable (L, -3);
- }
- if (addr->domain_len > 0) {
- lua_pushstring (L, "domain");
- lua_pushlstring (L, addr->domain, addr->domain_len);
- lua_settable (L, -3);
- }
- else {
- lua_pushstring (L, "domain");
- lua_pushstring (L, "");
- lua_settable (L, -3);
- }
- if (addr->user_len > 0) {
- lua_pushstring (L, "user");
- lua_pushlstring (L, addr->user, addr->user_len);
- lua_settable (L, -3);
- }
- else {
- lua_pushstring (L, "user");
- lua_pushstring (L, "");
- lua_settable (L, -3);
- }
- }
- }
-
- static void
- lua_push_emails_address_list (lua_State *L, GPtrArray *addrs)
- {
- struct rspamd_email_address *addr;
- guint i;
-
- lua_createtable (L, addrs->len, 0);
-
- for (i = 0; i < addrs->len; i ++) {
- addr = g_ptr_array_index (addrs, i);
- lua_push_email_address (L, addr);
- lua_rawseti (L, -2, i + 1);
- }
- }
-
- static gint
- lua_task_get_recipients (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- InternetAddressList *addrs = NULL;
- GPtrArray *ptrs = NULL;
- gint what = 0;
-
- if (task) {
- if (lua_gettop (L) == 2) {
- /* Get what value */
- what = lua_task_str_to_get_type (L, 2);
- }
-
- switch (what) {
- case RSPAMD_ADDRESS_SMTP:
- /* Here we check merely envelope rcpt */
- ptrs = task->rcpt_envelope;
- break;
- case RSPAMD_ADDRESS_MIME:
- /* Here we check merely mime rcpt */
- addrs = task->rcpt_mime;
- break;
- case RSPAMD_ADDRESS_ANY:
- default:
- if (task->rcpt_envelope) {
- ptrs = task->rcpt_envelope;
- }
- else {
- addrs = task->rcpt_mime;
- }
- break;
- }
-
- if (addrs) {
- lua_push_internet_address_list (L, addrs);
- }
- else if (ptrs) {
- lua_push_emails_address_list (L, ptrs);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- #define CHECK_ADDR(addr) do { \
- if (addr == NULL) { \
- ret = 0; \
- } \
- else { \
- ret = internet_address_list_length (addr) > 0 ? 1 : 0; \
- } \
- } while (0)
-
- #define CHECK_EMAIL_ADDR(addr) do { \
- if (addr == NULL) { \
- ret = 0; \
- } \
- else { \
- ret = addr->flags & RSPAMD_EMAIL_ADDR_VALID; \
- } \
- } while (0)
-
- #define CHECK_EMAIL_ADDR_LIST(addr) do { \
- if (addr == NULL) { \
- ret = 0; \
- } \
- else { \
- ret = addr->len > 0; \
- } \
- } while (0)
-
- static gint
- lua_task_has_from (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gint what = 0;
- gboolean ret = FALSE;
-
- if (task) {
- if (lua_gettop (L) == 2) {
- /* Get what value */
- what = lua_task_str_to_get_type (L, 2);
- }
-
- switch (what) {
- case RSPAMD_ADDRESS_SMTP:
- /* Here we check merely envelope rcpt */
- CHECK_EMAIL_ADDR (task->from_envelope);
- break;
- case RSPAMD_ADDRESS_MIME:
- /* Here we check merely mime rcpt */
- CHECK_ADDR (task->from_mime);
- break;
- case RSPAMD_ADDRESS_ANY:
- default:
- CHECK_EMAIL_ADDR (task->from_envelope);
-
- if (!ret) {
- CHECK_ADDR (task->from_mime);
- }
- break;
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- lua_pushboolean (L, ret);
-
- return 1;
- }
-
- static gint
- lua_task_has_recipients (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gint what = 0;
- gboolean ret = FALSE;
-
- if (task) {
- if (lua_gettop (L) == 2) {
- /* Get what value */
- what = lua_task_str_to_get_type (L, 2);
- }
-
- switch (what) {
- case RSPAMD_ADDRESS_SMTP:
- /* Here we check merely envelope rcpt */
- CHECK_EMAIL_ADDR_LIST (task->rcpt_envelope);
- break;
- case RSPAMD_ADDRESS_MIME:
- /* Here we check merely mime rcpt */
- CHECK_ADDR (task->rcpt_mime);
- break;
- case RSPAMD_ADDRESS_ANY:
- default:
- CHECK_EMAIL_ADDR_LIST (task->rcpt_envelope);
-
- if (!ret) {
- CHECK_ADDR (task->rcpt_mime);
- }
- break;
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- lua_pushboolean (L, ret);
-
- return 1;
- }
-
- static gint
- lua_task_get_from (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- InternetAddressList *addrs = NULL;
- struct rspamd_email_address *addr = NULL;
- gint what = 0;
-
- if (task) {
- if (lua_gettop (L) == 2) {
- /* Get what value */
- what = lua_task_str_to_get_type (L, 2);
- }
-
- switch (what) {
- case RSPAMD_ADDRESS_SMTP:
- /* Here we check merely envelope rcpt */
- addr = task->from_envelope;
- break;
- case RSPAMD_ADDRESS_MIME:
- /* Here we check merely mime rcpt */
- addrs = task->from_mime;
- break;
- case RSPAMD_ADDRESS_ANY:
- default:
- if (task->from_envelope) {
- addr = task->from_envelope;
- }
- else {
- addrs = task->from_mime;
- }
- break;
- }
-
- if (addrs) {
- lua_push_internet_address_list (L, addrs);
- }
- else if (addr) {
- /* Create table to preserve compatibility */
- if (addr->addr) {
- lua_createtable (L, 1, 0);
- lua_push_email_address (L, addr);
- lua_rawseti (L, -2, 1);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_user (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- if (task->user != NULL) {
- lua_pushstring (L, task->user);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_user (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *new_user;
-
- if (task) {
- new_user = luaL_checkstring (L, 2);
- if (new_user) {
- task->user = rspamd_mempool_strdup (task->task_pool, new_user);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_get_from_ip (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- rspamd_lua_ip_push (L, task->from_addr);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_from_ip (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *ip_str = luaL_checkstring (L, 2);
- rspamd_inet_addr_t *addr = NULL;
-
- if (!task || !ip_str) {
- lua_pushstring (L, "invalid parameters");
- return lua_error (L);
- }
- else {
- if (!rspamd_parse_inet_address (&addr,
- ip_str,
- 0)) {
- msg_warn_task ("cannot get IP from received header: '%s'",
- ip_str);
- }
- else {
- if (task->from_addr) {
- rspamd_inet_address_destroy (task->from_addr);
- }
-
- task->from_addr = addr;
- }
- }
-
- return 0;
- }
-
- static gint
- lua_task_get_from_ip_num (lua_State *L)
- {
- msg_err ("this function is deprecated and should no longer be used");
- lua_pushnil (L);
- return 1;
- }
-
- static gint
- lua_task_get_client_ip (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- rspamd_lua_ip_push (L, task->client_addr);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_helo (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- if (task->helo != NULL) {
- lua_pushstring (L, (gchar *)task->helo);
- return 1;
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_helo (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *new_helo;
-
- if (task) {
- new_helo = luaL_checkstring (L, 2);
- if (new_helo) {
- task->helo = rspamd_mempool_strdup (task->task_pool, new_helo);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_get_hostname (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- if (task->hostname != NULL) {
- /* Check whether it looks like an IP address */
- if (*task->hostname == '[') {
- /*
- * From the milter documentation:
- * If the reverse lookup fails or if none of the IP
- * addresses of the resolved host name matches the
- * original IP address, hostname will contain the
- * message sender's IP address enclosed in square
- * brackets (e.g. `[a.b.c.d]')
- */
- lua_pushstring (L, "unknown");
- }
- else {
- lua_pushstring (L, task->hostname);
- }
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_hostname (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *new_hostname;
-
- if (task) {
- new_hostname = luaL_checkstring (L, 2);
- if (new_hostname) {
- task->hostname = rspamd_mempool_strdup (task->task_pool,
- new_hostname);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_get_images (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- guint nelt = 0, i;
- struct rspamd_mime_part *part;
- struct rspamd_image **pimg;
-
- if (task) {
- lua_newtable (L);
-
- for (i = 0; i < task->parts->len; i ++) {
- part = g_ptr_array_index (task->parts, i);
-
- if (part->flags & RSPAMD_MIME_PART_IMAGE) {
- pimg = lua_newuserdata (L, sizeof (struct rspamd_image *));
- rspamd_lua_setclass (L, "rspamd{image}", -1);
- *pimg = part->specific_data;
- lua_rawseti (L, -2, ++nelt);
- }
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_archives (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- guint nelt = 0, i;
- struct rspamd_mime_part *part;
- struct rspamd_archive **parch;
-
- if (task) {
- lua_createtable (L, task->parts->len, 0);
-
- for (i = 0; i < task->parts->len; i ++) {
- part = g_ptr_array_index (task->parts, i);
-
- if (part->flags & RSPAMD_MIME_PART_ARCHIVE) {
- parch = lua_newuserdata (L, sizeof (struct rspamd_archive *));
- rspamd_lua_setclass (L, "rspamd{archive}", -1);
- *parch = part->specific_data;
- lua_rawseti (L, -2, ++nelt);
- }
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static inline gboolean
- lua_push_symbol_result (lua_State *L,
- struct rspamd_task *task,
- struct metric *metric,
- const gchar *symbol)
- {
- struct metric_result *metric_res;
- struct symbol *s;
- gint j;
- GList *opt;
-
- metric_res = g_hash_table_lookup (task->results, metric->name);
- if (metric_res) {
- if ((s = g_hash_table_lookup (metric_res->symbols, symbol)) != NULL) {
- j = 1;
- lua_newtable (L);
- lua_pushstring (L, "metric");
- lua_pushstring (L, metric->name);
- lua_settable (L, -3);
- lua_pushstring (L, "score");
- lua_pushnumber (L, s->score);
- lua_settable (L, -3);
-
- if (s->def && s->def->gr) {
- lua_pushstring (L, "group");
- lua_pushstring (L, s->def->gr->name);
- lua_settable (L, -3);
- }
- else {
- lua_pushstring (L, "group");
- lua_pushstring (L, "ungrouped");
- lua_settable (L, -3);
- }
-
- if (s->options) {
- opt = s->options;
- lua_pushstring (L, "options");
- lua_newtable (L);
-
- while (opt) {
- lua_pushstring (L, opt->data);
- lua_rawseti (L, -2, j++);
- opt = g_list_next (opt);
- }
-
- lua_settable (L, -3);
- }
-
- return TRUE;
- }
- }
-
- return FALSE;
- }
-
- static gint
- lua_task_get_symbol (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *symbol;
- struct metric *metric;
- GList *cur = NULL, *metric_list;
- gboolean found = FALSE;
- gint i = 1;
-
- symbol = luaL_checkstring (L, 2);
-
- if (task && symbol) {
- metric_list = g_hash_table_lookup (task->cfg->metrics_symbols, symbol);
- if (metric_list) {
- lua_newtable (L);
- cur = metric_list;
- }
- else {
- metric = task->cfg->default_metric;
- }
-
- if (!cur && metric) {
- if ((found = lua_push_symbol_result (L, task, metric, symbol))) {
- lua_newtable (L);
- lua_rawseti (L, -2, i++);
- }
- }
- else {
- while (cur) {
- metric = cur->data;
- if (lua_push_symbol_result (L, task, metric, symbol)) {
- lua_rawseti (L, -2, i++);
- found = TRUE;
- }
- cur = g_list_next (cur);
- }
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- if (!found) {
- lua_pushnil (L);
- }
-
- return 1;
- }
-
- static gint
- lua_task_has_symbol (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *symbol;
- struct metric_result *mres;
- gboolean found = FALSE;
-
- symbol = luaL_checkstring (L, 2);
-
- if (task && symbol) {
- mres = g_hash_table_lookup (task->results, DEFAULT_METRIC);
-
- if (mres) {
- found = g_hash_table_lookup (mres->symbols, symbol) != NULL;
- }
-
- lua_pushboolean (L, found);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_symbols (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct metric_result *mres;
- gint i = 1;
- GHashTableIter it;
- gpointer k, v;
- struct symbol *s;
-
- if (task) {
- mres = g_hash_table_lookup (task->results, DEFAULT_METRIC);
-
- if (mres) {
- lua_createtable (L, g_hash_table_size (mres->symbols), 0);
- lua_createtable (L, g_hash_table_size (mres->symbols), 0);
- g_hash_table_iter_init (&it, mres->symbols);
-
- while (g_hash_table_iter_next (&it, &k, &v)) {
- s = v;
- lua_pushstring (L, k);
- lua_rawseti (L, -3, i);
- lua_pushnumber (L, s->score);
- lua_rawseti (L, -2, i);
- i ++;
- }
- }
- else {
- lua_createtable (L, 0, 0);
- lua_createtable (L, 0, 0);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 2;
- }
-
- static gint
- lua_task_get_symbols_numeric (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct metric_result *mres;
- gint i = 1, id;
- GHashTableIter it;
- gpointer k, v;
- struct symbol *s;
-
- if (task) {
- mres = g_hash_table_lookup (task->results, DEFAULT_METRIC);
-
- if (mres) {
- lua_createtable (L, g_hash_table_size (mres->symbols), 0);
- lua_createtable (L, g_hash_table_size (mres->symbols), 0);
-
- g_hash_table_iter_init (&it, mres->symbols);
-
- while (g_hash_table_iter_next (&it, &k, &v)) {
- id = rspamd_symbols_cache_find_symbol (task->cfg->cache,
- k);
- s = v;
- lua_pushnumber (L, id);
- lua_rawseti (L, -3, i);
- lua_pushnumber (L, s->score);
- lua_rawseti (L, -2, i);
- i ++;
- }
- }
- else {
- lua_createtable (L, 0, 0);
- lua_createtable (L, 0, 0);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 2;
- }
-
- enum lua_date_type {
- DATE_CONNECT = 0,
- DATE_MESSAGE,
- DATE_CONNECT_STRING,
- DATE_MESSAGE_STRING
- };
-
- static enum lua_date_type
- lua_task_detect_date_type (lua_State *L, gint idx, gboolean *gmt)
- {
- enum lua_date_type type = DATE_CONNECT;
-
- if (lua_type (L, idx) == LUA_TNUMBER) {
- gint num = lua_tonumber (L, idx);
- if (num >= DATE_CONNECT && num <= DATE_MESSAGE_STRING) {
- return num;
- }
- }
- else if (lua_type (L, idx) == LUA_TTABLE) {
- const gchar *str;
-
- lua_pushvalue (L, idx);
- lua_pushstring (L, "format");
- lua_gettable (L, -2);
- str = lua_tostring (L, -1);
- if (g_ascii_strcasecmp (str, "message") == 0) {
- type = DATE_MESSAGE;
- }
- else if (g_ascii_strcasecmp (str, "connect_str") == 0) {
- type = DATE_CONNECT_STRING;
- }
- else if (g_ascii_strcasecmp (str, "message_str") == 0) {
- type = DATE_MESSAGE_STRING;
- }
- lua_pop (L, 1);
-
- lua_pushstring (L, "gmt");
- lua_gettable (L, -2);
-
- if (lua_type (L, -1) == LUA_TBOOLEAN) {
- *gmt = lua_toboolean (L, -1);
- }
-
- /* Value and table */
- lua_pop (L, 2);
- }
-
- return type;
- }
-
- static gint
- lua_task_get_date (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gdouble tim;
- enum lua_date_type type = DATE_CONNECT;
- gboolean gmt = TRUE;
-
- if (task != NULL) {
- if (lua_gettop (L) > 1) {
- type = lua_task_detect_date_type (L, 2, &gmt);
- }
- /* Get GMT date and store it to time_t */
- if (type == DATE_CONNECT || type == DATE_CONNECT_STRING) {
- tim = (tv_to_msec (&task->tv)) / 1000.;
-
- if (!gmt) {
- struct tm t;
- time_t tt;
-
- tt = tim;
- localtime_r (&tt, &t);
- #if !defined(__sun)
- t.tm_gmtoff = 0;
- #endif
- t.tm_isdst = 0;
- tim = mktime (&t);
- }
- }
- else {
- if (task->message) {
- time_t tt;
- gint offset;
- g_mime_message_get_date (task->message, &tt, &offset);
-
- if (!gmt) {
- tt += (offset * 60 * 60) / 100 + (offset * 60 * 60) % 100;
- }
- tim = tt;
- }
- else {
- tim = 0.0;
- }
- }
-
- if (type == DATE_CONNECT || type == DATE_MESSAGE) {
- lua_pushnumber (L, tim);
- }
- else {
- GTimeVal tv;
- gchar *out;
-
- double_to_tv (tim, &tv);
- out = g_time_val_to_iso8601 (&tv);
- lua_pushstring (L, out);
- g_free (out);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_message_id (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- if (task->message_id != NULL) {
- lua_pushstring (L, task->message_id);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_timeval (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- lua_createtable (L, 0, 2);
- lua_pushstring (L, "tv_sec");
- lua_pushnumber (L, (lua_Number)task->tv.tv_sec);
- lua_settable (L, -3);
- lua_pushstring (L, "tv_usec");
- lua_pushnumber (L, (lua_Number)task->tv.tv_usec);
- lua_settable (L, -3);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_size (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
- lua_pushnumber (L, task->msg.len);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- /**
- * - `no_log`: do not log task summary
- * - `no_stat`: do not include task into scanned stats
- * - `pass_all`: check all filters for task
- * - `extended_urls`: output extended info about urls
- * - `skip`: skip task processing
- */
-
- #define LUA_TASK_FLAG_WRITE(flag, set) do { \
- task->flags = (set) ? (task->flags | (flag)) : (task->flags & ~(flag)); \
- } while(0)
-
- #define LUA_TASK_SET_FLAG(flag, strname, macro, set) do { \
- if (!found && strcmp ((flag), strname) == 0) { \
- LUA_TASK_FLAG_WRITE((macro), set); \
- found = TRUE; \
- } \
- } while(0)
-
- #define LUA_TASK_FLAG_READ(flag) do { \
- lua_pushboolean(L, !!(task->flags & (flag))); \
- } while(0)
-
- #define LUA_TASK_GET_FLAG(flag, strname, macro) do { \
- if (!found && strcmp ((flag), strname) == 0) { \
- LUA_TASK_FLAG_READ((macro)); \
- found = TRUE; \
- } \
- } while(0)
-
- static gint
- lua_task_set_flag (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *flag = luaL_checkstring (L, 2);
- gboolean set = TRUE, found = FALSE;
-
- if (lua_gettop (L) >= 3) {
- set = lua_toboolean (L, 3);
- }
-
- if (task != NULL && flag != NULL) {
- LUA_TASK_SET_FLAG (flag, "pass_all", RSPAMD_TASK_FLAG_PASS_ALL, set);
- LUA_TASK_SET_FLAG (flag, "no_log", RSPAMD_TASK_FLAG_NO_LOG, set);
- LUA_TASK_SET_FLAG (flag, "no_stat", RSPAMD_TASK_FLAG_NO_STAT, set);
- LUA_TASK_SET_FLAG (flag, "skip", RSPAMD_TASK_FLAG_SKIP, set);
- LUA_TASK_SET_FLAG (flag, "extended_urls", RSPAMD_TASK_FLAG_EXT_URLS, set);
- LUA_TASK_SET_FLAG (flag, "learn_spam", RSPAMD_TASK_FLAG_LEARN_SPAM, set);
- LUA_TASK_SET_FLAG (flag, "learn_ham", RSPAMD_TASK_FLAG_LEARN_HAM, set);
- LUA_TASK_SET_FLAG (flag, "broken_headers",
- RSPAMD_TASK_FLAG_BROKEN_HEADERS, set);
-
- if (!found) {
- msg_warn_task ("unknown flag requested: %s", flag);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_has_flag (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *flag = luaL_checkstring (L, 2);
- gboolean found = FALSE;
-
- if (task != NULL && flag != NULL) {
- LUA_TASK_GET_FLAG (flag, "pass_all", RSPAMD_TASK_FLAG_PASS_ALL);
- LUA_TASK_GET_FLAG (flag, "no_log", RSPAMD_TASK_FLAG_NO_LOG);
- LUA_TASK_GET_FLAG (flag, "no_stat", RSPAMD_TASK_FLAG_NO_STAT);
- LUA_TASK_GET_FLAG (flag, "skip", RSPAMD_TASK_FLAG_SKIP);
- LUA_TASK_GET_FLAG (flag, "extended_urls", RSPAMD_TASK_FLAG_EXT_URLS);
- LUA_TASK_GET_FLAG (flag, "learn_spam", RSPAMD_TASK_FLAG_LEARN_SPAM);
- LUA_TASK_GET_FLAG (flag, "learn_ham", RSPAMD_TASK_FLAG_LEARN_HAM);
- LUA_TASK_GET_FLAG (flag, "broken_headers",
- RSPAMD_TASK_FLAG_BROKEN_HEADERS);
-
- if (!found) {
- msg_warn_task ("unknown flag requested: %s", flag);
- lua_pushboolean (L, 0);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_flags (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gint idx = 1;
- guint flags, bit, i;
-
- if (task) {
- lua_createtable (L, 8, 0);
-
- flags = task->flags;
-
- for (i = 0; i < sizeof (task->flags) * NBBY; i ++) {
- bit = (1U << i);
-
- if (flags & bit) {
- switch (bit) {
- case RSPAMD_TASK_FLAG_PASS_ALL:
- lua_pushstring (L, "pass_all");
- lua_rawseti (L, -2, idx ++);
- break;
- case RSPAMD_TASK_FLAG_NO_LOG:
- lua_pushstring (L, "no_log");
- lua_rawseti (L, -2, idx++);
- break;
- case RSPAMD_TASK_FLAG_NO_STAT:
- lua_pushstring (L, "no_stat");
- lua_rawseti (L, -2, idx++);
- break;
- case RSPAMD_TASK_FLAG_SKIP:
- lua_pushstring (L, "skip");
- lua_rawseti (L, -2, idx++);
- break;
- case RSPAMD_TASK_FLAG_EXT_URLS:
- lua_pushstring (L, "extended_urls");
- lua_rawseti (L, -2, idx++);
- break;
- case RSPAMD_TASK_FLAG_BROKEN_HEADERS:
- lua_pushstring (L, "broken_headers");
- lua_rawseti (L, -2, idx++);
- break;
- case RSPAMD_TASK_FLAG_LEARN_SPAM:
- lua_pushstring (L, "learn_spam");
- lua_rawseti (L, -2, idx++);
- break;
- case RSPAMD_TASK_FLAG_LEARN_HAM:
- lua_pushstring (L, "learn_ham");
- lua_rawseti (L, -2, idx++);
- break;
- default:
- break;
- }
- }
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_digest (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gchar hexbuf[33];
- gint r;
-
- if (task) {
- r = rspamd_encode_hex_buf (task->digest, sizeof (task->digest),
- hexbuf, sizeof (hexbuf) - 1);
-
- if (r > 0) {
- hexbuf[r] = '\0';
- lua_pushstring (L, hexbuf);
- }
- else {
- lua_pushnil (L);
- }
-
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_learn (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- gboolean is_spam = FALSE;
- const gchar *clname = NULL;
- GError *err = NULL;
- int ret = 1;
-
- if (task == NULL) {
- return luaL_error (L, "invalid arguments");
- }
-
- is_spam = lua_toboolean(L, 2);
- if (lua_gettop (L) > 2) {
- clname = luaL_checkstring (L, 3);
- }
-
- if (!rspamd_learn_task_spam (task, is_spam, clname, &err)) {
- lua_pushboolean (L, FALSE);
- if (err != NULL) {
- lua_pushstring (L, err->message);
- ret = 2;
- }
- }
- else {
- lua_pushboolean (L, TRUE);
- }
-
- return ret;
- }
-
- static gint
- lua_task_set_settings (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- ucl_object_t *settings;
- const ucl_object_t *act, *elt, *metric_elt;
- struct metric_result *mres;
- guint i;
-
- settings = ucl_object_lua_import (L, 2);
-
- if (settings != NULL && task != NULL) {
-
- metric_elt = ucl_object_lookup (settings, DEFAULT_METRIC);
-
- if (metric_elt) {
- task->settings = ucl_object_ref (metric_elt);
- ucl_object_unref (settings);
- }
- else {
- task->settings = settings;
- }
-
- act = ucl_object_lookup (task->settings, "actions");
-
- if (act) {
- /* Adjust desired actions */
- mres = g_hash_table_lookup (task->results, DEFAULT_METRIC);
-
- if (mres == NULL) {
- mres = rspamd_create_metric_result (task, DEFAULT_METRIC);
- }
-
- for (i = 0; i < METRIC_ACTION_MAX; i++) {
- elt = ucl_object_lookup_any (act, rspamd_action_to_str (i),
- rspamd_action_to_str_alt (i), NULL);
-
- if (elt) {
- mres->actions_limits[i] = ucl_object_todouble (elt);
- msg_debug_task ("adjusted action %s to %.2f",
- ucl_object_key (elt), mres->actions_limits[i]);
- }
- }
- }
-
- rspamd_symbols_cache_process_settings (task, task->cfg->cache);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_set_rmilter_reply (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- ucl_object_t *reply;
-
- reply = ucl_object_lua_import (L, 2);
-
- if (reply != NULL && task != NULL) {
- rspamd_mempool_set_variable (task->task_pool, "rmilter-reply",
- reply, (rspamd_mempool_destruct_t)ucl_object_unref);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 0;
- }
-
- static gint
- lua_task_get_settings (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task != NULL) {
-
- if (task->settings) {
- return ucl_object_push_lua (L, task->settings, true);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_lookup_settings (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *key = NULL;
- const ucl_object_t *elt;
-
- if (task != NULL) {
-
- if (lua_isstring (L, 2)) {
- key = lua_tostring (L, 2);
- }
-
- if (task->settings) {
- if (key == NULL) {
- return ucl_object_push_lua (L, task->settings, true);
- }
- else {
- elt = ucl_object_lookup (task->settings, key);
-
- if (elt) {
- return ucl_object_push_lua (L, elt, true);
- }
- else {
- lua_pushnil (L);
- }
- }
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_settings_id (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- guint32 *hp;
-
- if (task != NULL) {
- hp = rspamd_mempool_get_variable (task->task_pool, "settings_hash");
-
- if (hp) {
- lua_pushnumber (L, *hp);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_cache_get (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- msg_err_task ("this function is deprecated and will return nothing");
- }
-
- lua_pushnumber (L, -1);
-
- return 1;
- }
-
- static gint
- lua_task_cache_set (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
-
- if (task) {
- msg_err_task ("this function is deprecated and will return nothing");
- }
-
- lua_pushnumber (L, 0);
-
- return 1;
- }
-
- static gint
- lua_task_process_regexp (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- struct rspamd_lua_regexp *re = NULL;
- gboolean strong = FALSE;
- const gchar *type_str = NULL, *header_str = NULL;
- gsize header_len = 0;
- GError *err = NULL;
- gint ret = 0;
- enum rspamd_re_type type = RSPAMD_RE_BODY;
-
- /*
- * - `re`* : regular expression object
- * - `type`*: type of regular expression:
- * + `mime`: mime regexp
- * + `rawmime`: raw mime regexp
- * + `header`: header regexp
- * + `rawheader`: raw header expression
- * + `body`: raw body regexp
- * + `url`: url regexp
- * - `header`: for header and rawheader regexp means the name of header
- * - `strong`: case sensitive match for headers
- */
- if (task != NULL) {
- if (!rspamd_lua_parse_table_arguments (L, 2, &err,
- "*re=U{regexp};*type=S;header=V;strong=B",
- &re, &type_str, &header_len, &header_str,
- &strong)) {
- msg_err_task ("cannot get parameters list: %e", err);
-
- if (err) {
- g_error_free (err);
- }
- }
- else {
- type = rspamd_re_cache_type_from_string (type_str);
-
- if ((type == RSPAMD_RE_HEADER || type == RSPAMD_RE_RAWHEADER)
- && header_str == NULL) {
- msg_err_task (
- "header argument is mandatory for header/rawheader regexps");
- }
- else {
- ret = rspamd_re_cache_process (task, re->re, type,
- (gpointer) header_str, header_len, strong);
- }
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- lua_pushnumber (L, ret);
-
- return 1;
- }
-
- static gint
- lua_task_get_metric_score (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *metric_name;
- gdouble rs;
- struct metric_result *metric_res;
-
- metric_name = luaL_checkstring (L, 2);
-
- if (task && metric_name) {
- if ((metric_res =
- g_hash_table_lookup (task->results, metric_name)) != NULL) {
- lua_createtable (L, 2, 0);
- lua_pushnumber (L, metric_res->score);
- rs = rspamd_task_get_required_score (task, metric_res);
- lua_rawseti (L, -2, 1);
- lua_pushnumber (L, rs);
- lua_rawseti (L, -2, 2);
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_get_metric_action (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *metric_name;
- struct metric_result *metric_res;
- enum rspamd_metric_action action;
-
- metric_name = luaL_checkstring (L, 2);
-
- if (metric_name == NULL) {
- metric_name = DEFAULT_METRIC;
- }
-
- if (task && metric_name) {
- if ((metric_res =
- g_hash_table_lookup (task->results, metric_name)) != NULL) {
- action = rspamd_check_action_metric (task, metric_res);
- lua_pushstring (L, rspamd_action_to_str (action));
- }
- else {
- lua_pushnil (L);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_metric_score (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *metric_name;
- struct metric_result *metric_res;
- gdouble nscore;
-
- metric_name = luaL_checkstring (L, 2);
- nscore = luaL_checknumber (L, 3);
-
- if (metric_name == NULL) {
- metric_name = DEFAULT_METRIC;
- }
-
- if (task && metric_name) {
- if ((metric_res =
- g_hash_table_lookup (task->results, metric_name)) != NULL) {
- metric_res->score = nscore;
- lua_pushboolean (L, true);
- }
- else {
- lua_pushboolean (L, false);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_task_set_metric_action (lua_State *L)
- {
- struct rspamd_task *task = lua_check_task (L, 1);
- const gchar *metric_name, *action_name;
- struct metric_result *metric_res;
- gint action;
-
- metric_name = luaL_checkstring (L, 2);
-
- if (metric_name == NULL) {
- metric_name = DEFAULT_METRIC;
- }
-
- action_name = luaL_checkstring (L, 3);
-
- if (task && metric_name && action_name) {
- if ((metric_res =
- g_hash_table_lookup (task->results, metric_name)) != NULL) {
-
- if (rspamd_action_from_str (action_name, &action)) {
- metric_res->action = action;
- lua_pushboolean (L, true);
- }
- else {
- lua_pushboolean (L, false);
- }
- }
- else {
- lua_pushboolean (L, false);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- /* Image functions */
- static gint
- lua_image_get_width (lua_State *L)
- {
- struct rspamd_image *img = lua_check_image (L);
-
- if (img != NULL) {
- lua_pushnumber (L, img->width);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_image_get_height (lua_State *L)
- {
- struct rspamd_image *img = lua_check_image (L);
-
- if (img != NULL) {
- lua_pushnumber (L, img->height);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_image_get_type (lua_State *L)
- {
- struct rspamd_image *img = lua_check_image (L);
-
- if (img != NULL) {
- lua_pushstring (L, rspamd_image_type_str (img->type));
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_image_get_size (lua_State *L)
- {
- struct rspamd_image *img = lua_check_image (L);
-
- if (img != NULL) {
- lua_pushinteger (L, img->data->len);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_image_get_filename (lua_State *L)
- {
- struct rspamd_image *img = lua_check_image (L);
-
- if (img != NULL && img->filename != NULL) {
- lua_pushstring (L, img->filename);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- /* Arvhive methods */
- static gint
- lua_archive_get_type (lua_State *L)
- {
- struct rspamd_archive *arch = lua_check_archive (L);
-
- if (arch != NULL) {
- lua_pushstring (L, rspamd_archive_type_str (arch->type));
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_archive_get_files (lua_State *L)
- {
- struct rspamd_archive *arch = lua_check_archive (L);
- guint i;
- struct rspamd_archive_file *f;
-
- if (arch != NULL) {
- lua_createtable (L, arch->files->len, 0);
-
- for (i = 0; i < arch->files->len; i ++) {
- f = g_ptr_array_index (arch->files, i);
-
- lua_pushlstring (L, f->fname->str, f->fname->len);
- lua_rawseti (L, -2, i + 1);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_archive_get_files_full (lua_State *L)
- {
- struct rspamd_archive *arch = lua_check_archive (L);
- guint i;
- struct rspamd_archive_file *f;
-
- if (arch != NULL) {
- lua_createtable (L, arch->files->len, 0);
-
- for (i = 0; i < arch->files->len; i ++) {
- f = g_ptr_array_index (arch->files, i);
-
- lua_createtable (L, 0, 4);
-
- lua_pushstring (L, "name");
- lua_pushlstring (L, f->fname->str, f->fname->len);
- lua_settable (L, -3);
-
- lua_pushstring (L, "compressed_size");
- lua_pushnumber (L, f->compressed_size);
- lua_settable (L, -3);
-
- lua_pushstring (L, "uncompressed_size");
- lua_pushnumber (L, f->uncompressed_size);
- lua_settable (L, -3);
-
- lua_pushstring (L, "encrypted");
- lua_pushboolean (L, (f->flags & RSPAMD_ARCHIVE_FILE_ENCRYPTED) ? true : false);
- lua_settable (L, -3);
-
- lua_rawseti (L, -2, i + 1);
- }
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_archive_is_encrypted (lua_State *L)
- {
- struct rspamd_archive *arch = lua_check_archive (L);
-
- if (arch != NULL) {
- lua_pushboolean (L, (arch->flags & RSPAMD_ARCHIVE_ENCRYPTED) ? true : false);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_archive_get_size (lua_State *L)
- {
- struct rspamd_archive *arch = lua_check_archive (L);
-
- if (arch != NULL) {
- lua_pushinteger (L, arch->size);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_archive_get_filename (lua_State *L)
- {
- struct rspamd_archive *arch = lua_check_archive (L);
-
- if (arch != NULL) {
- lua_pushstring (L, arch->archive_name);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- /* Text methods */
- static gint
- lua_text_len (lua_State *L)
- {
- struct rspamd_lua_text *t = lua_check_text (L, 1);
- gsize l = 0;
-
- if (t != NULL) {
- l = t->len;
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- lua_pushnumber (L, l);
-
- return 1;
- }
-
- static gint
- lua_text_str (lua_State *L)
- {
- struct rspamd_lua_text *t = lua_check_text (L, 1);
-
- if (t != NULL) {
- lua_pushlstring (L, t->start, t->len);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_text_ptr (lua_State *L)
- {
- struct rspamd_lua_text *t = lua_check_text (L, 1);
-
- if (t != NULL) {
- lua_pushlightuserdata (L, (gpointer)t->start);
- }
- else {
- return luaL_error (L, "invalid arguments");
- }
-
- return 1;
- }
-
- static gint
- lua_text_gc (lua_State *L)
- {
- struct rspamd_lua_text *t = lua_check_text (L, 1);
-
- if (t != NULL) {
- if (t->flags & RSPAMD_TEXT_FLAG_OWN) {
- if (t->flags & RSPAMD_TEXT_FLAG_MMAPED) {
- munmap ((gpointer)t->start, t->len);
- }
- else {
- g_free ((gpointer)t->start);
- }
- }
-
- }
-
- return 0;
- }
-
- /* Init part */
-
- static gint
- lua_load_task (lua_State * L)
- {
- lua_newtable (L);
- luaL_register (L, NULL, tasklib_f);
-
- return 1;
- }
-
- static void
- luaopen_archive (lua_State * L)
- {
- rspamd_lua_new_class (L, "rspamd{archive}", archivelib_m);
- lua_pop (L, 1);
- }
-
- void
- luaopen_task (lua_State * L)
- {
- rspamd_lua_new_class (L, "rspamd{task}", tasklib_m);
- lua_pop (L, 1);
-
- rspamd_lua_add_preload (L, "rspamd_task", lua_load_task);
-
- luaopen_archive (L);
- }
-
- void
- luaopen_image (lua_State * L)
- {
- rspamd_lua_new_class (L, "rspamd{image}", imagelib_m);
- lua_pop (L, 1);
- }
-
- void
- luaopen_text (lua_State *L)
- {
- rspamd_lua_new_class (L, "rspamd{text}", textlib_m);
- lua_pop (L, 1);
- }
-
- void
- rspamd_lua_task_push (lua_State *L, struct rspamd_task *task)
- {
- struct rspamd_task **ptask;
-
- ptask = lua_newuserdata (L, sizeof (gpointer));
- rspamd_lua_setclass (L, "rspamd{task}", -1);
- *ptask = task;
- }
|