Is there a way to patch a plugin?

[sdothum]

Specifically the vocabbuilder.koplugin.

i want to close the dictionary lookup popup when a word is added to the Vocabulary Builder database.

i am assuming the close needs be added to VocabBuilder:onDictButtonsReady function.

Saves just one button press action on the dictionary lookup.. but curious if this can be achieved.

[hius07]

Example of patching a plugin
https://github.com/koreader/koreader...ent-2393154113

[sdothum]

Thank you for the plugin patch example.

i've managed to override the VocabBuilder: onDictButtonsReady function but am stumped at what i was expecting to be the easiest part -- closing the DictQuickLookup window. More needs be done than simply calling DictQuickLookup: onClose() after the button tap.

Any ideas? before i create another thread post?

[sdothum]

Found the answer.. at least what appears to work. Instead of using DictQuickLookup:onClose..

UIManager:sendEvent(Event:new("Close"))

[Frenzie]

It's probably more proper to do UIManager:close(the_widget_in_question)

[sdothum]

Originally Posted by Frenzie

It's probably more proper to do UIManager:close(the_widget_in_question)

i thought about that but could not figure out how to specify the widget id of the QuickDictLookup widget.

[hius07]

It is dict_popup.

[sdothum]

The UIManager:close(dict_popup) does close the widget..

BUT this action also appears to bypass the widget's DictQuickLookup: onClose() function -- at least, the scheduled highlight clear is not triggered after the widget is closed (i do patch that to lengthen its duration before clearing).

The UIManager:sendEvent() close appears to be a more graceful action in this regard, clearing the highlight afterwards.

[hius07]

dict_popup:onClose()

[sdothum]

Thank you! Adding that direct call works.

A question:
- the UIManager:close() plus dict_popup: onClose() are two statements versus the single UIManager:sendEvent() statement -- with the proposed changes more widget explicit.

Is there a reason to discourage the sendEvent() usage (which has not presented any issues for this usecase)? i'm guessing the above is more immune to future coding changes or are there other possible semantic reasons?

[hius07]

Direct calls are cheaper than events.
Events can be handled by many listeners, for example, renaming a book title and resetting some caches here and there.

[hius07]

https://koreader.rocks/doc/topics/Events.md.html#

[JimmXinu]

A similar question if I may:

Is there a way to patch something in a plugin that's not in the main plugin object?

I'm trying to patch in a replacement for CalibreSearch.switchResults() in calibre.koplugin/search.lua.

I'm trying to replace the sort with one that does lower() before compare so lower case Calibre titles, tags, etc aren't after all the upper case ones.

(I suspect patching sort.natsort_cmp would be easier, but it's also used by other things.)

[hius07]

CalibreSearch can be found as an upvalue in some of the main module methods.
Look for example at
https://github.com/koreader/koreader...ent-2871327027

[JimmXinu]

Originally Posted by hius07

CalibreSearch can be found as an upvalue in some of the main module methods.
Look for example at
https://github.com/koreader/koreader...ent-2871327027

I got as far as userpatch.getUpValue() before, but apparently I misunderstand it.

I have:

local userpatch = require("userpatch")

userpatch.registerPatchPluginFunc("calibre", function(Calibre)

    local CalibreSearch, up_idx = userpatch.getUpValue(Calibre.onCalibreSearch, "CalibreSearch")

    print("\ncalibre patch CalibreSearch:")
    print(CalibreSearch)
    
end)

And calibre.koplugin/main.lua contains a reference to CalibreSearch:

function Calibre:onCalibreSearch()
    CalibreSearch:ShowSearch()
    return true
end

But I just get 'nil' printed in the crash.log.

ADDENDUM

Of all the Calibre methods that reference CalibreSearch, getSearchMenuTable is the only one that gives me that reference from getUpValue:

userpatch.registerPatchPluginFunc("calibre", function(Calibre)

    local CalibreSearch, up_idx = userpatch. getUpValue(Calibre.getSearchMenuTable, "CalibreSearch")

    print("\ncalibre patch CalibreSearch:")
    print(CalibreSearch)
    
end)

No idea why that one works and the others don't.