Magnet Link Library 3.0 LUA 5.1

[lUk3f1l3w4lK3R]

Hi everybody,

first of all this script is originally written by St0ne db and i use it since a few years now.
For the fact that it version 2.0 from this script dont work with the newest version from PtokaX
i thought its time to start learning LUA myself and convert this amazing script.

And now here it is: Magnet Link Library 3.0

Its not only converted - i have also added and changed some things in this script (read more about it in the script).

For everybody who dont know this script:
This is a Release & Request bot with alot of features
- Add/Remove Categories
- Add/Remove Releases
- Add/Remove Requests
- Add comments to releases
- Vote for the releases
- Add a description to the releases
- Add Magnet links to the releases
- Add Weblinks to the releases
- Nuke releases
- Ranking system
....

I have tested it alot (cause its the first time i converted a script) and couldnt find any error in it.
If you find any error let me know. And also feedback is welcome.

best regards
lUk3f1l3w4lK3R


Edit:
I have noticed that i had attached the wrong version to this post.
The one i had attached didnt send the RCMenu to registered users (only to op and higher).
I have updated the attachment with the correct version.

cheers

[lUk3f1l3w4lK3R]

Code: [Select]

---------------------------------------------------------------------------------------------------------
-- Mlink.Library.v3.0a.LUA5.X-PtokaX          [ by: St0ne db ] [Modded by: lUk3f1l3w4lK3R]
---------------------------------------------------------------------------------------------------------
--
--  A new kind of release and request bot.
--
----[ Tested With ]--------------------------------------------------------------------------------------
--
-- PtokaX v0.3.5.1c & PtokaX v0.3.5.1d - [ Lua 5.0.3 and Lua 5.1.1 ]
--
-- Version 3.0 tested with
-- PtokaX v0.4.1.2
--
----[ Version 3.0a Change Log ]-[by lUk3f1l3w4lK3R]----------------------------------------
-- Fixed: Bug in change skin
--
----[ Version 3.0 Change Log ]-[by lUk3f1l3w4lK3R]-----------------------------------------
-- Added: Error report to OP in pm
-- Added: Memory use report in pm (when script is started and stopped)
-- Added: Message to user that RC commands are enabled (Send in main)
-- Added: RC SubMenu - taken from scriptname or use "Custom Name"
-- Changed: RC Menu - is now taken from hubname or use "Custom Name"
-- Added: Help (sends available commands to user in main)
-- Added: Converted to new API
Attachment in first post updated

[Jorgo]

Thank you, this looks like a cool enhancement on freshstuff. I'll give it a whirl on ADCH++.

Update: Do you think it would be possible to implement the possibility to change releases without deleting them? That would make things a lot easier. Thanks for considering this!

[redford]

I'm implementing this script for my hub (was trying freshstuff but this is superior) and it is revolutionizing how our entire hub works. It is amazing!

There's one major thing we're looking for though, and that's editing existing releases. (the release name, and also contents of the release info).

Currently we can only change something by deleting and re-adding, a cumbersome process.

Like jorgo suggested, is there a chance this might be possible? I am not sure how complicated adding an 'edit release' function would be, it seems pretty central to the script with a lot to do with the database and maintaining it etc...but maybe it's not that complicated ...

Many thanks!!!!

[lUk3f1l3w4lK3R]

I will try to add this option but this can take some time cause i just started learning LUA.

Btw there is allready something like this, not exactly an edit option,
but when using the wizard to add a release/request
you can allways type:
back - for going a page back

and there is the verification of the release/request information you wanna post.
At this point of the wizard you get a preview of your post.
If something is wrong just type back and edit the things you wanna edit.

Anyway thx for the feedback and suggestion.

[redford]

Brilliant, thank you!! <3

If there's any way I can help, testing etc, let me know.

Patiently waiting, and glad to know you're onto it!!

thanks for this

[pR0Ps]

First of all, this is an awesome request/release bot and it is much appreciated that you took the time to update it. A couple of things for the next release:

What this script is really missing is a way to "fill" requests. Right now I don't see any way of doing that so the requests just stay in the requests section until they expire, filled or not. What this script needs is a "FillReq" wizard.

The help should be dynamically served based on what privileges the user has. Also, it doesn't reflect any changes you might make to the commands at the top of the script.

Lastly, the right click menu doesn't take into account the fact that the user of the script may want to give users less power and make some more functions inaccessible to them. The RC menu is hard-coded much like the help in that if you change variables at the top, users will get RC commands they won't be able to use.

pR0Ps

EDIT: The tweaks here will work on an unmodified version of MLink Lib 3.0a. I have released my fully modified version with all these tweaks and more farther down.



HELP + RIGHT CLICK FIX:

Add this table to the config area at the top of the script:

Code: [Select]

tHelp = {
--Syntax = {<command>, <permission (must return pUser/pAdmin)>, <description>, <RC location + name>, <RC params (include a space before the params)>},

--Wizard commands
{tCmd.sAddRel, wAccess["AddRel"], "Add a release", "Add Release", ""},
{tCmd.sReq, wAccess["AddReq"], "Add a request", "Add Request", ""},
{tCmd.sDelRel, wAccess["DelRel"], "Delete a release/request", "Delete Release/Request", ""},
{tCmd.sShowRel, wAccess["ShowRel"], "Show releases", "Show Releases", ""},
{tCmd.sAddCat, wAccess["AddCat"], "Add a release category", "Categories\\Add Category", ""},
{tCmd.sDelCat, wAccess["DelCat"], "Delete a release category", "Categories\\Delete Category", ""},
--Quick commands
{tCmd.qComment, tAccess[tCmd.qComment], "Show your releases comments", "Show My Comments", ""},
{tCmd.qMag, tAccess[tCmd.qMag], "Show all releases with maglinks", "Show MagLinks", ""},
{tCmd.qRank, tAccess[tCmd.qRank], "Show your releases and rank", "Show My Profile", ""},
{tCmd.qClean, tAccess[tCmd.qClean], "Clean the release list", "Clean Releases", ""},
}
NOTES: This table is needed for both the help and RC fixes. Also, I removed some features (quick commands, URLs, skinning, etc.) from my version of MLink Lib so some commands are not in the tHelp table, put them in using the proper format (listed) if you use them.


SHOWING HELP:
Use the following method to return the help string to send to the user

Code: [Select]

--Returns a string containing help on using MLink Lib's functions
getHelp = function (user, param)
local str = "\n\n\tRELEASE/REQUEST HELP:\n"
if param == nil or param == "" then
--General help
for _, item in ipairs (tHelp) do
if (item[2][user.iProfile] == 1) then
local a = item[1]
if string.len(a) < 7 then
a = a .. "\t"
end
str = str.."\n\t"..tVar.sTrig..a.."\t\t"..item[3]
end
end
return str.."\n\n\tType "..tVar.sTrig..tCmd.qHelp.." <command> for info on that specific command\n"
else
--look for specific match
for _, item in ipairs (tHelp) do
if (param == item[1] and item[2][user.iProfile] == 1) then
return str.."\n\tCommand: "..tVar.sTrig..item[1].."\n\tDescription: "..item[3].."\n\
end
end
--filter by text
str = str.."\n\tCommands filtered by '"..param.."':\n"
local found = false
for _, item in ipairs (tHelp) do
local a = item[1]
if (string.find(a, param) and item[2][user.iProfile] == 1) then
if string.len(a) < 7 then
a = a .. "\t"
end
found = true
str = str.."\n\t"..tVar.sTrig..a.."\t\t"..item[3]
end
end
if found then
return str.."\n\n\tType "..tVar.sTrig..tCmd.qHelp.." <command> for info on that specific command\n"
else
return str.."\n\tSorry, no commands found, try just '"..tVar.sTrig..tCmd.qHelp.."'\n"
end
end
end
HELP NOTES: You will have to do some coding to integrate it into your script. It does not directly output the help, but instead returns it as a string. You will have to use

Code: [Select]

Core.SendToUser(user, getHelp(user, param)) to send the data. It can optionally take in a param that can be used to search commands or show more details for a specific one.

RIGHT CLICKS:
Replace the

Code: [Select]

if string.lower(tVar.sRC) == "on" then block in the UserConnected function with the following:

Code: [Select]

if string.lower(tVar.sRC) == "on" then
if Core.GetUserValue(user,12) then
local str = ""
for _, item in ipairs (tHelp) do
if (item[2][user.iProfile] == 1) then
str = str.."$UserCommand 1 3 "..tVar.sRCMenu.."\\"..tVar.sRCSubMenu.."\\"..item[4].."$<%[mynick]> "..tVar.sTrig..item[1]..item[5].."&#124;|"
end
end
Core.SendToUser(user, str.."<".tVar.sBot.."> Welcome "..user.sNick.." MLinkLib 3.0 commands enabled. Right click hub tab or user list for menu.|")
end
end


VOTING FIX:
I kept running into a bug while using the voting feature (it would crash when you had already voted on a release, then tried to vote again, while skipping the comment. I have traced the bug to the Wizard.AddVote method (in Wizard.lua). It tries to call the

Code: [Select]

Wizard.AddVote[5](skin) method (the finish screen) which doesn't exist. Also, if it DID call it, it wouldn't find the file AddVote5.txt (not included in any of the skins). To fix this I added the Wizard.AddVote[5](skin) method below:

Code: [Select]

[5] = function(skin)
return doLoadFile("skin/"..skin.."/AddVote5.txt");
end,
Then went into every skin folder and renamed Vote5.txt to AddVote5.txt. You can delete the other Vote#.txt files, they aren't used anywhere in the script. Personally, I even changed the

Code: [Select]

elseif step == 5 and string.lower(data) == "yes" then
block to

Code: [Select]

elseif step == 5 and string.lower(data) == "yes" then
     LibTask.Vote(user,temp);
     msg = Wizard.AddVote[5]();
     Wizard.InitTemp(user,"Clear");
This effectively quits the user after they have rated a release, instead of showing the release list again.

VOTING BUG FIX:
When you have already voted (so you cant again and it skips you to the comment step), at the comment step, all you have to do is type 'b' or 'back' to go back and edit your rating. This messes up the rating count because you have edited your rating, but also added 1 to the rating count. Using this fix, users will still be allowed to go back and input a rating, but it won't make any difference. Simply add the following code to the bottom of the

Code: [Select]

elseif step == 4 then block in the Wizard.AddVote["Start"] method.

Code: [Select]

if Library[tonumber(temp.rel.cat)]["items"][tonumber(temp.rel.var)]["voted"][user.sNick] then
      temp.vote.rating = "Not Rated";
end
This simply checks again if the user has already voted right before the they confirm the data and it gets sent to the LibTask.Vote() method and changes it without the possibility of the user modifying it.

DISCLAIMER: My version of MLink has been heavily edited and tweaked so if something doesn't work, thats why. I've tried to make these snippits compatible with the original, but I may have missed something.

I will post my complete script once I have finished adding the features I want to it. EDIT: Posted

[st0ne-db]

Glad to see this script has been translated. 
Respect to lUk3f1l3w4lK3R and pR0Ps for their work.

-St0ne

[pR0Ps]

All the tweaks I was doing were getting really hard to keep separate and post for an unmodified version of the script so I'm just going to post the entire thing here as a mod. It includes all the tweaks above, plus some more features. On the other hand, it also removes a lot of features because I made this for my personal hub and took out anything I didn't want/need. I present to you: Magnet Link Library 3.0a - pR0PsMod LUA 5.1

Quick Changelog:

Fixed: Voting bug
Removed: Skinning option and built in skin (only the 'simple' skin now)
Removed: Option for custom help command (is now !help)
Removed: Reporting memory usage
Removed: URLs from releases
Removed: Seperate notification bot (all through main Library bot now)
Removed: All quick commands that have wizard counterparts
Changed: The main skin was modified in places
Changed: New release notifications are now only one line (less obtrusive)
Changed: Less obtrusive authorization errors
Changed: Permissions are now true/false, not 1/0 (easier if statement checking)
Changed: The ChatArrival function now displays help and passes the command through to the hubsoft (you get both help texts)
Changed: Countless minor tweaks
Added: Dynamic help system
Added: Dynamic right click menu
Added: Option for multiple command triggers with a default for displaying within help
Added: Mechanism for filling requests (with skin)
Added: Optional integration of offline request filled notifications (use your own script)
Added: Library method for adding points to a users' rank

Complete script is attached

EDIT: Bug was found and fixed, see later post for script

[pR0Ps]

BUG FOUND:

Scope: This effects the non-modded version by lUk3f1l3w4lK3R as well as the pR0PsMod.

Cause: Special characters (characters represented by %[hex value], like %5D represents '[') being inputted into the bot (in release names, magnet links, etc.)

Effect: In some cases it causes the script to not display the entire message the special character was encompassed in.

Temporary fix: Manually edit the database, replacing all the %[hex value]s with their character equivalent, then restart the script.

A permanent fix is in the works (when I finish exams), If you find any more bugs, let me know. Also, if you have a fix for it, post it below.

[Sarge]

Fix this bug, try convert magnet-link utf8ToAnsi
Add in main script

Code: [Select]

url = require("socket.url")

local ansi_decode={
  [128]='\208\130',[129]='\208\131',[130]='\226\128\154',[131]='\209\147',[132]='\226\128\158',[133]='\226\128\166',
  [134]='\226\128\160',[135]='\226\128\161',[136]='\226\130\172',[137]='\226\128\176',[138]='\208\137',[139]='\226\128\185',
  [140]='\208\138',[141]='\208\140',[142]='\208\139',[143]='\208\143',[144]='\209\146',[145]='\226\128\152',
  [146]='\226\128\153',[147]='\226\128\156',[148]='\226\128\157',[149]='\226\128\162',[150]='\226\128\147',[151]='\226\128\148',
  [152]='\194\152',[153]='\226\132\162',[154]='\209\153',[155]='\226\128\186',[156]='\209\154',[157]='\209\156',
  [158]='\209\155',[159]='\209\159',[160]='\194\160',[161]='\209\142',[162]='\209\158',[163]='\208\136',
  [164]='\194\164',[165]='\210\144',[166]='\194\166',[167]='\194\167',[168]='\208\129',[169]='\194\169',
  [170]='\208\132',[171]='\194\171',[172]='\194\172',[173]='\194\173',[174]='\194\174',[175]='\208\135',
  [176]='\194\176',[177]='\194\177',[178]='\208\134',[179]='\209\150',[180]='\210\145',[181]='\194\181',
  [182]='\194\182',[183]='\194\183',[184]='\209\145',[185]='\226\132\150',[186]='\209\148',[187]='\194\187',
  [188]='\209\152',[189]='\208\133',[190]='\209\149',[191]='\209\151'
}
local utf8_decode={
  [128]={[147]='\150',[148]='\151',[152]='\145',[153]='\146',[154]='\130',[156]='\147',[157]='\148',[158]='\132',[160]='\134',[161]='\135',[162]='\149',[166]='\133',[176]='\137',[185]='\139',[186]='\155'},
  [130]={[172]='\136'},
  [132]={[150]='\185',[162]='\153'},
  [194]={[152]='\152',[160]='\160',[164]='\164',[166]='\166',[167]='\167',[169]='\169',[171]='\171',[172]='\172',[173]='\173',[174]='\174',[176]='\176',[177]='\177',[181]='\181',[182]='\182',[183]='\183',[187]='\187'},
  [208]={[129]='\168',[130]='\128',[131]='\129',[132]='\170',[133]='\189',[134]='\178',[135]='\175',[136]='\163',[137]='\138',[138]='\140',[139]='\142',[140]='\141',[143]='\143',[144]='\192',[145]='\193',[146]='\194',[147]='\195',[148]='\196',
    [149]='\197',[150]='\198',[151]='\199',[152]='\200',[153]='\201',[154]='\202',[155]='\203',[156]='\204',[157]='\205',[158]='\206',[159]='\207',[160]='\208',[161]='\209',[162]='\210',[163]='\211',[164]='\212',[165]='\213',[166]='\214',
    [167]='\215',[168]='\216',[169]='\217',[170]='\218',[171]='\219',[172]='\220',[173]='\221',[174]='\222',[175]='\223',[176]='\224',[177]='\225',[178]='\226',[179]='\227',[180]='\228',[181]='\229',[182]='\230',[183]='\231',[184]='\232',
    [185]='\233',[186]='\234',[187]='\235',[188]='\236',[189]='\237',[190]='\238',[191]='\239'},
  [209]={[128]='\240',[129]='\241',[130]='\242',[131]='\243',[132]='\244',[133]='\245',[134]='\246',[135]='\247',[136]='\248',[137]='\249',[138]='\250',[139]='\251',[140]='\252',[141]='\253',[142]='\254',[143]='\255',[144]='\161',[145]='\184',
    [146]='\144',[147]='\131',[148]='\186',[149]='\190',[150]='\179',[151]='\191',[152]='\188',[153]='\154',[154]='\156',[155]='\158',[156]='\157',[158]='\162',[159]='\159'},[210]={[144]='\165',[145]='\180'}
}

local nmdc = {
  [36] = '$',
  [124] = '|'
}

function AnsiToUtf8(s)
  local r, b = ''
  for i = 1, s and s:len() or 0 do
    b = s:byte(i)
    if b < 128 then
      r = r..string.char(b)
    else
      if b > 239 then
        r = r..'\209'..string.char(b - 112)
      elseif b > 191 then
        r = r..'\208'..string.char(b - 48)
      elseif ansi_decode[b] then
        r = r..ansi_decode[b]
      else
        r = r..'_'
      end
    end
  end
  return r
end

function Utf8ToAnsi(s)
  local a, j, r, b = 0, 0, ''
  for i = 1, s and s:len() or 0 do
    b = s:byte(i)
    if b < 128 then
      if nmdc[b] then
        r = r..nmdc[b]
      else
        r = r..string.char(b)
      end
    elseif a == 2 then
      a, j = a - 1, b
    elseif a == 1 then
      a, r = a - 1, r..utf8_decode[j][b]
    elseif b == 226 then
      a = 2
    elseif b == 194 or b == 208 or b == 209 or b == 210 then
      j, a = b, 1
    else
      r = r..'_'
    end
  end
  return r
endUse:

Code: [Select]

["LatestRel"] = function(temp)
--local s = "\tID:\tИнформация:\n\t"..string.rep("-",160)
local s = ""
                                          local d = Wizard.Show.Divider(temp.skin);
for z = TableMaxSize(LibLast), 1, -1 do
local i = tonumber(LibLast[z]["cat"]);
local n = tonumber(LibLast[z]["rel"]);
local mLink = Library[i]["items"][n]["mlink"];
local name = Library[i]["items"][n]["name"];
if mLink == "Не задано" then
name = url.unescape(name);
name = Utf8ToAnsi(name);
mLink = ""
else
mLink = url.unescape(mLink);
mLink = Utf8ToAnsi(mLink);
mLink = "\n\t\tMagnet: "..mLink
end
local r = "\n\t"..i.."."..n.."\t"..name
.." из категории: "..Library[i]["cname"]
..". Автор: "..Library[i]["items"][n]["poster"]..", дата "..Library[i]["items"][n]["date"]..mLink
s = s..string.gsub(d,"{release}",r);
--s = string.gsub(d,"{release}",r);
end
return s;
end,Use this in all places where it's need.

[pR0Ps]

Fixed the major bug.

EDIT: Removed dependencies on custom "fcns" library

[Cariga]

Hi. I'm getting this error :
[01:13] Syntax ...cripts\MLinkLib.v3.1-pR0PsMod.LUA5.0X-PtokaX.lua.lua:115: module 'fcns' not found:
   no field package.preload['fcns']
   no file 'C:\Huburi & radio\Huburi\Huburi\Ptokax412+Leviathan6.2FINAL\fcns.lua'
   no file 'C:\Huburi & radio\Huburi\Huburi\Ptokax412+Leviathan6.2FINAL\libs\fcns.lua'
   no file 'C:\Huburi & radio\Huburi\Huburi\Ptokax412+Leviathan6.2FINAL\scripts\libs\fcns.lua'
   no file 'C:\Huburi & radio\Huburi\Huburi\Ptokax412+Leviathan6.2FINAL\fcns.dll'
   no file 'C:\Huburi & radio\Huburi\Huburi\Ptokax412+Leviathan6.2FINAL\libs\fcns.dll'
   no file 'C:\Huburi & radio\Huburi\Huburi\Ptokax412+Leviathan6.2FINAL\scripts\libs\fcns.dll'

From where can i get the fcns.dll ?

[pR0Ps]

Sorry, I forgot to remove the dependencies on the "fcns" library that I use. File in this post is now fixed.