Modules are used to extend and modify the way ZNC functions. Users interact with modules most commonly by messaging a special user on IRC. For example, to view the highlight keywords in your watch list, you"d send /msg *watch list. When ZNC sees that the nick you"re messaging starts with an asterisk, it doesn"t forward the message to the IRCd/server but instead sends it to the proper module for processing. In this case, the watch module will get the message and reply to you with a listing of your keywords. This makes for a very convenient and standard way of configuring or otherwise communicating with your loaded modules, as well as a common and standard way for your loaded modules to display status or other information. Notice that this is for loaded modules. You must load a given module, for example /znc loadmod watch, before you can interface with the watch module. Most modules will reply to /msg *module help with a listing of available commands.
ZNC modules are loaded either globally, per-network, or on a per-user basis. Each module defines for itself whether it is available to load as global, network-specific and/or user-specific. User level and network modules can do things ranging from manipulating the incoming/outgoing messages to implementing a full blown Twitter client. They can also do more traditional IRC tasks such as challenge based auto-op , setting you away, or logging to disk. Each user gets to load and configure their own set of modules to customize their experience to suit their preference.
Global modules are loadable by admins and provide functionality or change behavior for all users. For example, the partyline module has to be global since it provides functionality for all users on a given ZNC instance to be able to communicate with each other from within ZNC itself. Global modules can do everything that user-level modules can do, as well as a few extras. They can replace ZNC"s authentication system, modify the config-writing process, deal with CAP, etc.
Feel free to create wikipages about modules you have created, but don"t forget to add a download link, contact information, and use the same layout as the rest of the modules. Contributions are always much appreciated.
Module List [ edit ]
Global Modules [ edit ]
adminlog Log user connects, disconnects, and failed logins to a file and/or to syslog. blocker Blocks certain users from using ZNC, saying their account was disabled. certauth This module lets users log in via SSL client keys. cyrusauth This module is intended for admins who run a shell/web/email/etc server and want to provide ZNC access to their existing users. fail2ban Block IPs for some time after a failed login. identfile Posts the ident of a user to a file when they are trying to connect. imapauth Allow users to authenticate via IMAP. lastseen Logs when a user last logged in to ZNC. modperl Loads Perl scripts as ZNC modules. modpython Allows you to use modules written on Python. notify_connect Sends a notice to all admins when a user logs in or out of ZNC. partyline Allows ZNC users to join internal channels and query other ZNC users on the same ZNC. webadmin Allows you to add/remove/edit users and settings on the fly via a web browser.User Modules [ edit ]
admin(Now controlpanel) Allows you to add/remove/edit users and settings on the fly via IRC messages. autoattach Watches your detached channels and reattaches you automatically when there is specified activity in a channel you added to your autoattach list. autoreply Gives an automatic reply if someone messages you while you are away. block_motd Blocks the server's Message of the Day. bouncedcc Bounces DCC transfers through the znc server instead of sending them directly to the user. buffextras Add nick changes, joins, parts, topic changes etc. to your playback buffer. chansaver Saves channels to config when user joins and parts. charset Normalizes (i.e. converts) character encodings. clearbufferonmsg This module attempts to bridge the gap between being inundated with old buffer if you have KeepBuffer=true; and possibly missing messages when you ping out, if you have KeepBuffer=false. clientnotify Notify about new incoming connections to your user. controlpanel Allows you to add/remove/edit users and settings on the fly via IRC messages. ctcpflood This module tries to block CTCP floods. dcc This module allows you to transfer files to and from ZNC disconkick This module will kick your client from all channels if ZNC disconnects from server. flooddetach This module detaches you from channels which are flooded. listsockets This module displays a list of all open sockets in ZNC. log Log chat activity to file. missingmotd This user module will send 422 to clients when they login. notes Keep and replay notes. This is an example of WebMods. sample This is an example module to help with writing modules to do whatever you want. send_raw Allows you to send raw traffic to IRC from other users. shell Access your Unix shell via query right inside of your IRC client.Network Modules [ edit ]
autocycle Rejoin a channel when you are the only one there (to gain operator status). autoop Automatically give operator status to the good guys. modtcl Allows you to run Tcl scripts in ZNC. autovoice Automatically give voice status to everyone who joins some channel. awaynick Change your nick while you are away. awaystore When you are set away or detached, this module will save all private messages for you. The messages can be read until you delete them. This module will also set you away when you are idle some time. cert This module lets users use their own SSL certificate to connect to a server. crypt Encryption for channel/private messages. keepnick Tries to get and keep your primary nick if it is taken. kickrejoin Implements auto-rejoin-on-kick. modules_online Fakes online status of ZNC modules to fix some clients. nickserv Auths you with NickServ. perform Performs commands on connect. Auths you with Q (and a little more). raw View all of the raw traffic. route_replies Routes back answers to the right client when connected with multiple clients. sasl Allows you to authenticate to an IRC network via SASL savebuff Saves your channel buffers into an encrypted file so they can survive restarts and reboots. schat SSL (encrypted) DCC chats. simple_away Automatically set you away on IRC when disconnected from the bouncer. stickychan Keeps you in specified channels. watch Monitor activity for specific text patterns from specific users and have the text sent to a special query window.More Modules [ edit ]
Managing Modules [ edit ]
Modules can be added or removed easily. Modules can be stored in ~/.znc/modules and /usr/local/lib/znc by default. ZNC installs its modules to that second directory, which in fact is $(prefix)/lib/znc , but this can be changed with ./configure --module-prefix=DIR before compiling.
ZNC will first look in the local sub-directory modules when searching for modules. Only files that end with ".so" will be seen as a module. To remove modules you can simply delete them from the folder. No other configuration changes or restarts are necessary. To remove, but also keep a module for later use you can also change the name, like: mv sample.so sample.so_ .
To compile a new module you must first save the source as a ".cpp" file. Compiling modules describes the process in detail.
Global, user, and network modules can be (un)loaded from webadmin or via the *status query window, like:
/msg *status LoadMod [--type=global|user|network]
- configuration
- [--type=global|user|network] optionally specifies whether to (un)load the module as a global, user, or network module. Not all modules can be loaded at all levels; see individual Module documentation to find out where it may be loaded.
is based on the modules file name, excluding the ".so" extension. Are specific for each module and not required: You can provide parameters when loading the module, or you can set up the module after loading it.
So, to load the log module at the global level (as opposed to user or network) and remove all color/formatting control codes with the -sanitize parameter, you would type:
/msg *status LoadMod --type=global log -sanitize
For older versions of ZNC, you won"t have the option to specify [--type=global|user|network]. In that case, just use:
/msg *status LoadMod
Please keep in mind that a user is not able to load a module if the directive "DenyLoadMod" is set to true. Trying to load a module will fail with "Unable to load [
If a module prevents ZNC from starting up and therefore you can"t unload the module using webadmin, you can edit znc.conf and remove the corresponding LoadModule line.
Using modules [ edit ]
It is recommended to read the module"s wikipage if you want to find out how a module works. Alternatively the following command can be used to get a command list:
/msg *
- * is the StatusPrefix set in your configuration. Usually it"s just an asterisk ("*").
After updating the version of Drupal on one of the sites where there were many handwritten modules, to my amazement I found several error messages in a row with the following content:
User warning: The following module is missing from the file system:...
Next came the names of the very modules that the system did not detect. I once wrote these modules myself, but during the creation process they somehow merged with others, were renamed or something else... in general, they are lost to history. At first I decided to give up on all this, but very quickly the inscription began to irritate me, and I went to look into it using the link that was listed next to the message about the problem. After reading the information, I realized that I was wrong when I deleted the modules immediately directly from the server, and did not use the admin panel options for this. Now I won’t describe in detail why this is bad, but it wasn’t worth doing, but Drupal itself did not stop such unworthy actions of developers. And in version 7.50 and higher, the creators of this glorious CMS decided to call everyone to order.
What to do if you, too, are tired of this annoying inscription and want to eliminate defects in the site settings? Everything is very simple and to solve the problem you don’t even need to search the Internet again for the modules that you removed and install them on the site again (as recommended by the Drupal developers). And even the fact that it was your own semi-finished product and you completely forgot about it does not mean that you will have to undergo a hypnosis session and restore the code from the depths of the subconscious. The problem can be solved in three simple steps:
That's all. I promised three steps, but it turned out to be six. But this does not mean that everything is difficult, I just stretched out the pleasure :) Good luck!
After the repository is cloned from GitHub, I enter npm install to install the dependencies and fail. Here is the process listing:
bimbatron:bem bimba$ npm install > [email protected] postinstall /Users/bimba/BEM > npm run deps > [email protected] deps /Users/bimba/BEM > bower i --allow-root bower EACCES EACCES: permission denied, mkdir "/Users/bimba/.cache/bower/registry/bower.herokuapp.com" Stack trace: Error: EACCES: permission denied, mkdir "/Users/bimba/.cache/bower/registry/bower.herokuapp.com" at Error (native) at Object.fs.mkdirSync (fs.js:922:18) at sync (/Users/bimba/ BEM/node_modules/bower/lib/node_modules/bower-registry-client/node_modules/mkdirp/index.js:55:12) at Function.sync (/Users/bimba/BEM/node_modules/bower/lib/node_modules/bower- registry-client/node_modules/mkdirp/index.js:61:24) at new Cache (/Users/bimba/BEM/node_modules/bower/lib/node_modules/bower-registry-client/lib/util/Cache.js:21 :16) at RegistryClient.
The first error that catches your eye is some path that contains a mention of heroku app. I tried clearing the bower cache, it didn’t help, the error appeared again (by the way, how to remove Heroku completely from the system?).
We have briefly touched on the topic of methods for displaying content in the body of a template. Let's now take a closer look at what it is and what it is eaten with. So, method declarations jdoc are present in every Joomla template and display this or that information in the body of the template (that is, on the site page). In general, the method declaration looks like this:
This line displays information from components on the site, for example articles from com_content. The type of output elements is specified in the attribute.
1. type - types of output elements.
- component- as I wrote above, displays the main content of the page. Can only be called once per template.
- head- is also announced once after the opening tag . Serves to display styles, scripts,
and metadata of the current page.</li><li><i>message</i><i>- </i> displays system messages. Declared once in the body of the document.</li><li><i>installation</i>- does not display anything and is an “instruction” for installation.</li><li><i>module -</i> displays a single module on the page. The number of advertisements is unlimited.</li><li><i>modules</i>- unlike the previous type, it allows you to display more than a single number of modules in its position.</li> </ul><p>For the first four types listed, you just need to indicate them on the page. In the case of the module type, the task becomes a little more complicated. In order to display a module on the page, we first need to create a module for it <b>modular position</b> with a unique identifier (module position name). This is done using the name="position name" attribute and the mandatory addition of the line:</p><p> <position>position name</position> to the templateDetails.xml file. By describing the name of the position in templateDetails.xml, we designate it in the system and see it in the module manager. The names of the positions can be arbitrary, although the name = "user3" position is used by default to display the top menu.</p><p><b>2. style - description of the output style (mod chrome).</b></p> <p>The appearance and structure of the module shell depends on the specified style. Looks like</p><p> :<jdoc:include type="modules" name="user1" style="xhtml" />By default, there are several styles of module output:</p><ul><li><i>xhtml -</i> displays the module in a block with the title function modChrome_xhtml($module, &$params, &$attribs) <br>{<br>if (!empty ($module->content)) : ?> <br> <div class="moduletable<?php echo htmlspecialchars($params->get("moduleclass_sfx")); ?>"> <br> <?php if ($module->showtitle != 0) : ?> <br> <h3><?php echo $module->title; ?></h3><br> <?php endif; ?><br> <?php echo $module->content; ?> <br> </div><br> <?php endif;<br>}</li><li><i>table -</i> displays the module in a table structure layout <br>function modChrome_table($module, &$params, &$attribs) <br>{ ?><br> <table cellpadding="0" cellspacing="0" class="moduletable<?php echo htmlspecialchars($params->get("moduleclass_sfx")); ?>"> <br> <?php if ($module->showtitle != 0) : ?> <br> <tr><br> <th><br> <?php echo $module->title; ?> <br> </th><br> </tr><br> <?php endif; ?><br> <tr><br> <td><br> <?php echo $module->content; ?> <br> </td><br> </tr><br> </table><br> <?php<br>}</li><li><i>horz -</i> displays the contents of a module in a table cell, horizontally function modChrome_horz($module, &$params, &$attribs) <br>{ ?><br> <table cellspacing="1" cellpadding="0" width="100%"><br> <tr><br> <td><br> <?php modChrome_table($module, $params, $attribs); ?><br> </td><br> </tr><br> </table><br> <?php<br>}</li><li><i>rounded</i>- displays the module in several nested blocks for complex styling in the form of graphic borders (e.g. rounded corners) function modChrome_rounded($module, &$params, &$attribs) <br>{ ?><br> <div class="module<?php echo htmlspecialchars($params->get("moduleclass_sfx")); ?>"> <br> <div><br> <div><br> <div><br> <?php if ($module->showtitle != 0) : ?> <br> <h3><?php echo $module->title; ?></h3><br> <?php endif; ?><br> <?php echo $module->content; ?> <br> </div><br> </div><br> </div><br> </div><br> <?php<br>}</li><li><i>outline</i>- adds preset css styles to the module block function modChrome_outline($module, &$params, &$attribs) <br>{<br>static $css=false; <br>if (!$css) <br> {<br>$css=true; <br>jimport("joomla.environment.browser"); <br>$doc = JFactory::getDocument(); <br>$browser = JBrowser::getInstance(); <br>$doc->addStyleDeclaration(".mod-preview-info ( padding: 2px 4px 2px 4px; border: 1px solid black; position: absolute; background-color: white; color: red;)"); <br>$doc->addStyleDeclaration(".mod-preview-wrapper ( background-color:#eee; border: 1px dotted black; color:#700;)"); <br>if ($browser->getBrowser()=="msie") <br> {<br>if ($browser->getMajor()<= 7) {<br>$doc->addStyleDeclaration(".mod-preview-info (filter: alpha(opacity=80);)"); <br>$doc->addStyleDeclaration(".mod-preview-wrapper (filter: alpha(opacity=50);)"); <br> } <br>else( <br>$doc->addStyleDeclaration(".mod-preview-info (-ms-filter: alpha(opacity=80);)"); <br>$doc->addStyleDeclaration(".mod-preview-wrapper (-ms-filter: alpha(opacity=50);)"); <br> } <br> } <br>else <br> {<br>$doc->addStyleDeclaration(".mod-preview-info (opacity: 0.8;)"); <br>$doc->addStyleDeclaration(".mod-preview-wrapper (opacity: 0.5;)"); <br> } <br> } <br> ?><br> <div class="mod-preview"><br> <div class="mod-preview-info"><?php echo $module->position."[".$module->style."]"; ?></div><br> <div class="mod-preview-wrapper"><br> <?php echo $module->content; ?> <br> </div><br> </div><br> <?php<br>}</li><li><i>none</i>- similar to style not specified at all. Displays a module without design and title function modChrome_none($module, &$params, &$attribs) <br>{<br>echo $module->content; <br>}</li> </ul><p>All preset styles are located in the file templates/system/html/modules.php. But we are not limited to using only the provided options, but are quite capable of creating our own.</p> <p><b>3. Create a custom chrome mode.</b></p> <p><b><br></b> So, the default module representation types provided do not meet current requirements. You need to add your own design style. As an example, let’s choose a fairly frequently repeated situation. According to the assignment, instead of <h3>put the module title in the tag <span>, which is semantically neutral. You also need to place the module content block in a separate <div>. To create your own module output style, we will use standard tools. Most Joomla templates have an html/ folder (templates/template name/html/), which is used for so-called templating. That is, if you copy a module template to this folder, then instead of the template from the modules/my_module/tmpl/default directory, the file from templates/template name/html/my_modules/default will be output. Components are templated in the same way. Convenient and practical. In the html/ folder of your template, create a file modules.php. If there is no such folder in the template, we will create it. Let's write it to a file</p><p> <?php<br>function modChrome_modbox($module, &$params, &$attribs) // Call the function <br>{<br>if (!empty ($module->content)) : /* Check if the position contains an enabled module */?> <br> <div class="moduletable<?php echo htmlspecialchars($params->get("moduleclass_sfx")); /* display the css suffix of the module class */ ?>"> <br> <?php if ($module->showtitle != 0) : /* check if the module title is included */ ?> <br> <span class="title"><?php echo $module->title; /* Print the title */ ?></span><br> <?php endif; ?><br> <div class="modcontent"><br> <?php echo $module->content; /* Output the contents of the module */ ?> <br> </div><br> </div><br> <?php endif;<br>} <br>?> Done. Now you just need to specify it as the output style. <jdoc:include type="modules" name="user1" style="modbox"/>We assign a module to our position and look at the result.</p> <script type="text/javascript"> <!-- var _acic={dataProvider:10};(function(){var e=document.createElement("script");e.type="text/javascript";e.async=true;e.src="https://www.acint.net/aci.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})() //--> </script><br> <br> <script>document.write("<img style='display:none;' src='//counter.yadro.ru/hit;artfast_after?t44.1;r"+ escape(document.referrer)+((typeof(screen)=="undefined")?"": ";s"+screen.width+"*"+screen.height+"*"+(screen.colorDepth? screen.colorDepth:screen.pixelDepth))+";u"+escape(document.URL)+";h"+escape(document.title.substring(0,150))+ ";"+Math.random()+ "border='0' width='1' height='1' loading=lazy loading=lazy>");</script> </div> </article> </div> </main> <noindex> <aside class="sidebar sidebar_midle"> <div class="section-posts-box section"> <div class="title">Popular articles</div> <div class="section-posts"> <div class="section-posts__item"> <img src="/uploads/8668364da7e802cd82369bdb63557a39.jpg" width="300" height="180" class="section-posts__item-img" alt="Who is Grigory Rasputin and what does he do?" / loading=lazy loading=lazy> <div class="section-posts__item-title"> <a href="https://netdenegnakino.ru/en/kto-takoi-grigorii-rasputin-chem-on-zanimaetsya-istoriya-zhizni-grigorii.html">Who is Grigory Rasputin and what does he do?</a> </div> <div class="section-posts__item-text">As is known from the brief biography, Rasputin was born into the family of a coachman on January 9, 1869 in...</div> <div class="post-info section-posts__item-info"> <time class="post-info__time post-info__time_popular" datetime="">2024-01-07 02:17:11</time> </div> </div> <div class="section-posts__item"> <img src="/uploads/0f24066992b9078b3168949548092fd2.jpg" width="300" height="180" class="section-posts__item-img" alt="Lesson summary “Automation of sound C Individual lesson automation of sound C in sentences" / loading=lazy loading=lazy> <div class="section-posts__item-title"> <a href="https://netdenegnakino.ru/en/konspekt-individualnogo-zanyatiya-avtomatizaciya-zvuka-v-slogah-i.html">Lesson summary “Automation of sound C Individual lesson automation of sound C in sentences</a> </div> <div class="section-posts__item-text">Summary of individual speech therapy classes in 4th grade. Topic: Sound automation [C]....</div> <div class="post-info section-posts__item-info"> <time class="post-info__time post-info__time_popular" datetime="">2024-01-06 02:13:45</time> </div> </div> <div class="section-posts__item"> <img src="/uploads/4ee4b78375d5455860308c21d5eccfa5.jpg" width="300" height="180" class="section-posts__item-img" alt="How to apply for the Unified State Exam for past graduates" / loading=lazy loading=lazy> <div class="section-posts__item-title"> <a href="https://netdenegnakino.ru/en/gde-sdayut-ege-kak-podat-zayavlenie-na-sdachu-ege-vypusknikam-proshlyh-let-na.html">How to apply for the Unified State Exam for past graduates</a> </div> <div class="section-posts__item-text">So, this year your child will face a real test - passing the Unified State Exam. You, probably,...</div> <div class="post-info section-posts__item-info"> <time class="post-info__time post-info__time_popular" datetime="">2024-01-05 02:11:32</time> </div> </div> </div> </div> <div class="section section_widget widget_text" id="text-7"> <div class="textwidget"> </div> </div> </aside> </noindex> </div> </div> <footer class="footer"> <link href="https://fonts.googleapis.com/css?family=Roboto:400,400i,500,700,700i&subset=cyrillic" rel="stylesheet"> <nav class="footer-nav"> <ul> <li class="menu-item type-post_type object-page "><a href="https://netdenegnakino.ru/en/feedback.html">Contacts</a></li> <li class="menu-item type-post_type object-page "><a href="https://netdenegnakino.ru/en/sitemap.xml">Site Map</a></li> </ul> </nav> <div class="footer-bottom"> <div class="copy">© 2024 netdenegnakino.ru - No for twos. Chemistry. Physics. Spelling. Geography</div> </div> </footer> </div> <script type='text/javascript'> /* <![CDATA[ */ var tocplus = { "smooth_scroll": "1", "visibility_show": "\u041f\u043e\u043a\u0430\u0437\u0430\u0442\u044c", "visibility_hide": "\u0421\u043a\u0440\u044b\u0442\u044c", "width": "Auto" }; /* ]]> */ </script> <script type='text/javascript' src='https://netdenegnakino.ru/wp-content/plugins/table-of-contents-plus/front.min.js?ver=1509'></script> <script type='text/javascript' src='https://netdenegnakino.ru/wp-content/plugins/wp-postratings/js/postratings-js.js?ver=1.85'></script> <script type='text/javascript'> var q2w3_sidebar_options = new Array(); q2w3_sidebar_options[0] = { "sidebar": "sidebar-2", "margin_top": 10, "margin_bottom": 0, "stop_id": "", "screen_max_width": 0, "screen_max_height": 0, "width_inherit": false, "refresh_interval": 1500, "window_load_hook": false, "disable_mo_api": false, "widgets": ['text-7', 'text-6'] }; </script> <script type='text/javascript' src='https://netdenegnakino.ru/wp-content/plugins/q2w3-fixed-widget/js/q2w3-fixed-widget.min.js?ver=5.0.4'></script> <script type='text/javascript' src='/wp-includes/js/wp-embed.min.js?ver=4.9.2'></script> </div> <script type="text/javascript"> <!-- var _acic={dataProvider:10};(function(){var e=document.createElement("script");e.type="text/javascript";e.async=true;e.src="https://www.acint.net/aci.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})() //--> </script><br> <br> </body> </html> <script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script>