# PerlCNF Perl based Configuration Network File Format Parser and Specifications. CNF file format supports used format extraction from any text file. Useful for templates and providing initial properties and values for various application settings. Has own textual data tag format. Therefore, can also be useful for database data batch processing. This project also contains custom build TestManager module for general and all test driven development. It is at current v.3.0 version, project is specification implemented, and test driven development produced. Public open source: git clone git://lifelog.hopto.org/PerlCNF ### [You can find the specification here](./Specifications_For_CNF_ReadMe.md). --- ## Release Status > http://lifelog.hopto.org/gitweb/?p=PerlCNF.git;a=summary * (2025-02-06) - v.3.3.3, **PerlCNF Final Minor New Release** * CNFNode - search and shortif algorithms revised and reimplemented. * TestManager updated and enhanced to make easier to locate tested files or possible errors. * CNFParser anechoic handling bettered, main CNF tag parsing routine revisited. * (2025-01-15) - v.3.3.2, **PerlCNF Minor New Release** * Has new CNFGlobalFile module, to deal with parameters for caching and content handling. * Is vscpde more friendly for logs outputs and tests. * CNFParser changes, log settings can now have relative folder paths in property assigned, that get auto created is missing. * (2024-07-06) - v.3.3.1, **PerlCNF Minor New Release** Further development on data plugins and tables. First simple many to one (any to single) relationship between tables implemented. * CNFSQL updated. * New [CentralDataPlugin](CentralDataPlugin) * Creates automated SQL queries and synchronization based on a TREE schema, fully automated. * CNF DATA based instructions, that is tables are converted automatically to and SQL database/ * TestManger major upgrade, has better output and error handling, argument options. * testAll.pl, reports better now, listing of failed cases last, to easier find. * Plugin Exception should not throw exceptions with trace from packages, is another observance. * (2024-06-25) - v.3.3, **PerlCNF Released** Preliminary release of v.3.3 has now pushed to the [gitweb](http://lifelog.hopto.org/gitweb/?p=PerlCNF.git;a=tree). Specification and release loge yet has to be updated. * Some major things in this one? Lots of work on the new DatabaseCentralPlugin and SQL functionality, * What this enables is that in you CNF script when placed can assign a CNF tree property containing column mapping and table specification which in turn is linked to an database, Refereed to as the store. The store the application uses to read and update. * So you can guess what happens when attaching a store to your script containing CNF data instructions. This plugin creates all the tables, statements and synchronizes the data changes made in your script with the store. Automatically. * CNF data are now in tables in direct array access providing the header. * (2023-08-23) - v.2.9, Final Release has been published. * Has new TestManager * CNFDateTime and DATE instruction. * CNFParser has post parsing processing beside normal plugins capabilities. * Sophisticated DATA plugins and processing basics implemented. * Webpage tree skeleton PerlCNF to HTML conversion. * Useful for inline testing and developing features for a given webpage, from one place. * Plugin reads the skeleton to react and produce HTML via automation, serious stuff. * Initial RSS Feeds development started, working with CNFNode translates based on setup. * These are a nightmare as arrive from the XML world. But are a good and old way to stream public news clips or content. * And once you got CNDNodes as data from one source, idea is you transfer it to another source, and like some relational database. * SQLite and Postgress Database functionality has been revisited. * (2023-08-08) - v.2.9, new DATE instruction has been implemented. * (2023-06-14) - v.2.9, new meta flags and priority can be set via these pre-evaluation settings for instructions. - Node processing on demand and JSON translation on demand of CNFNode's (TREE instruction) is now available. Online demo made available. * (2023-05-13) - v.2.8, has new instructions VARIABLE, to streamline under one tag like CONST, but for anons. Has better tag mauling algorithm. PLUGIN code has been improved, particularly the synchronizing and the linking of properties. * (2022-11-18) - PerlCNF now provides custom test manager and test cases. - That will in future be used for all projects as an copy from this project. This is all available in the ./test directory and is not a Perl module. --- ## Installation Of This Perl GitHub Project * Installation is standard. ```sh mkdir ~/dev; cd ~/dev git clone https://github.com/wbudic/PerlCNF.git cd PerlCNF ``` * To install required modules locally to home, do not run following with sudo in front. * For CGI based programs, you will need this run on system Perl level. * cd ~/dev/PerlCNF; #Perl tests and project directory is required to be the starting location. ```sh sudo ./install_cpan_modules_required.pl ``` ## Usage * Copy the system/modules/CNFParser.pm module into your project. * From your project you can modify and adopt, access it. * You can also make an perl bash script. ```perl use lib "system/modules"; use lib $ENV{'PWD'}.'/htdocs/cgi-bin/system/modules'; require CNFParser; my $cnf1 = new CNFParser('sample.cnf'); #Load config with enabled evaluation on the fly, of perl code embedded in config file. my $cnf2 = new CNFParser('sample.cnf',{DO_ENABLED=>1, duplicates_overwrite=0}); ``` ## Sample CNF File ```CNF <<>> <<$APP_DESCRIPTION This application presents just a nice multi-line template. >> <<@<@LIST_OF_COUNTRIES> Australia, USA, "Great Britain", 'Ireland', "Germany", Austria Spain, Serbia Russia Thailand, Greece >>> Note this text here, is like an comment, not affecting and simply ignored.

Other tags like this paragraph better put into a CNF property to be captured.

``` ```perl my $cnf = new CNFParser('sample.cnf'); my @LIST_OF_COUNTRIES = @{$cnf -> collection('@LIST_OF_COUNTRIES')}; print "[".join(',', sort @LIST_OF_COUNTRIES )."]"; #prints -> [Australia,Austria,Germany,Great Britain,Greece,Ireland,Russia,Serbia,Spain,Thailand,USA] print "App Name: ".$cnf->constant('$APP_NAME')."]"; #prints -> App Name: Test Application ``` ## Check Online Demo * Subject to availability, please check out the online demo ⇒ [PerlCNF Online](https://lifelog.hopto.org/index.cgi) * Access to it might raise browser certificate errors in your browser, that is ok. * It is at the moment an experimental development server. * All pages there are running and are implemented dynamically by using this framework and might be still in some sections, under development. * Yes the /index.cgi uses PerlCNF to render and work with an index.cnf file, containing page structure and all web page bits in one place. * There is a plugin for conversion from CNF to HTML and plugin for Markup to HTML, centralized all in this index.cnf file. ## Run Test Cases * Tests are located in the projects **./tests** directory. * Run individually or all at once with, (the __testAll.pl__ script will automatically select the test files and run them for you): ```sh perl ./tests/testAll.pl ``` * Check also the latest Perl CNF [example.cnf](./tests/example.cnf) scripted also as an tutorial. * Yes! That is an actual valid configuration file. * To only just run it or check use ``` perl ./tests/testExample.pl ``` --- TOC * [[You can find the specification here](./Specifications_For_CNF_ReadMe.md).](#[you-can-find-the-specification-here](./specifications_for_cnf_readme.md).) 1. [Release Status](#release-status) 2. [Installation Of This Perl GitHub Project](#installation-of-this-perl-github-project) 3. [Usage](#usage) 4. [Sample CNF File](#sample-cnf-file) 5. [Check Online Demo](#check-online-demo) 6. [Run Test Cases](#run-test-cases)