Octopussy::Report(3)

🎀 Octopussy::Report 💖

okay bestie, sit DOWN, because this is Octopussy::Report — the Report module from the Octopussy Perl fam, and it's lowkey the backbone of the whole reporting situation. it's giving "backstage crew at the concert" energy: you never see it, but nothing works without it. iykyk. ✨

---

🌸 NAME 🌸

Octopussy::Report — the Octopussy Report module. that's it, that's the name, she's iconic, she said what she said. 💅

---

✨ FUNCTIONS ✨

here's the whole roster, no skips, no shuffles, every single one. 🫶

🦋 New($conf)

Create a new Report. fresh out of the box, brand new baby report, welcome to the world little one 🌈

🦋 Remove($report)

Removes a Report '$report'. bye bestie, we'll miss you, but the vibes had to be cleansed. 💀

🦋 Modify($old_report, $conf_new)

Modifies the configuration for the Report '$old_report'. glow-up era fr fr ✨

🦋 List($category, $restriction_list)

Returns list of Reports with category '$category' (if specified) and restricted to list '$restriction_list' (if specified). so like, both filters are optional — pass them and she narrows it down, skip them and she shows you everyone. main character energy from both args tbh 👑

🦋 Filename($report_name)

Get the XML filename for the report '$report_name'. yes it's XML, no we're not debating it. 📄

🦋 Configuration($report)

Get the configuration for the report '$report'. just the one. singular. one report's whole config, served fresh. 🍓

🦋 Configurations($sort, $category)

Get the configuration for all reports. yes ALL of them, she's an overachiever and we love that for her. 🎀

🦋 Categories(@report_restriction_list)

Returns Reports Categories. plural categories, plural restriction list, plural everything. she contains multitudes. 💜

🦋 Request($table, $query)

Data Request with query '$query' from table '$table'. you bring the table, you bring the query, she brings the data. that's the deal. 🤝

🦋 Generate(...)

Generate($rc, $begin, $end, $outputfile, $devices, $services, $data,
    $conf_mail, $conf_ftp, $conf_scp, $stats, $lang)

no description in the source, bestie — she simply ✨exists✨. look at all those params though. the way that she takes $rc, $begin, $end, $outputfile, $devices, $services, $data, $conf_mail, $conf_ftp, $conf_scp, $stats, and $lang? a whole squad. 🔥

🦋 CmdLine_Export_Options($conf_mail, $conf_ftp, $conf_scp)

Generates Command Line Export Options (mail/ftp/scp). three ways to yeet your report into the world, and she builds the flags for all of them. 📬

🦋 CmdLine(...)

CmdLine($device, $service, $loglevel, $taxonomy, $report, $start, $finish,
    $pid_param, $conf_mail, $conf_ftp, $conf_scp, $lang)

Generates Command Line and launch octo_reporter. okay so she doesn't just write the command — she LAUNCHES the thing. ate and left no crumbs. 👑

🦋 Export($file, $conf_mail, $conf_ftp, $conf_scp)

Exports generated report via Mail, FTP, SCP if defined. "if defined" is doing a lot of heavy lifting there — no config, no export, simple as that. 💌

🦋 File_Info($file, $begin, $end, $devices, $services, $stats)

Generates Report's File Information. all the little details about your file, catalogued and cute. 🗂️

🦋 File_Info_Tooltip($file, $lang)

Prints Report's File Information in Tooltip. same info as above but it pops up when you hover, which is honestly such a serve. 🫧

🦋 Updates_Installation(@reports)

another one with no description in the source — she's mysterious, she's got @reports and she's not explaining herself. respect. 🙈

🦋 Running_List()

Returns list of Reports in progress. no args, no notes, just vibes and a status check on everything currently cooking. 🔄

🦋 Valid_Name($name)

Checks that '$name' is valid for a Report name. the vibe check function, literally. if your name doesn't pass, it doesn't pass, and that's that. ✅

---

👑 AUTHOR 👑

Sebastien Thebert <octo.devel@gmail.com> — the legend who built all of this, no cap. 🫶

---

that's the whole page, bestie — every function, every parameter, every word, nothing skipped. go forth and report responsibly. 💖

---

and one last thing for the sign-off: this whole page is from perl v5.22.2, dated 2016-05-04, filed under Octopussy::Report(3). vintage but make it ✨iconic✨. mwah, bye! 💅🎀🌈