Skip to content

Add command search when pipe is open #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wargio merged 1 commit into from
Nov 2, 2025
Merged

Add command search when pipe is open #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion assets/templates/console.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<body>
<form style="margin-top: 15px; height: 100%;" action="{{ .root }}output/exec/{{ .unique }}" method="POST">
<div class="form-group">
<input type="text" class="form-input" name="command" value="" placeholder="Rizin command for example: pdf"/>
<input type="text" class="form-input command-input" name="command" value="" placeholder="Rizin command for example: pdf"/>
</div>
<div class="form-group">
<button class="btn btn-primary" type="submit">Exec</button>
Expand Down
185 changes: 162 additions & 23 deletions assets/templates/page-view.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,43 @@
<link rel="stylesheet" href="{{ $root }}static/spectre.min.css">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type="text/css">
@font-face { font-family: 'Inconsolata'; src: URL('{{ .root }}static/inconsolata.ttf') format('truetype'); }
.spacing-top { margin: 3px 0px 0px 0px !important; }
.spacing-left { margin: 0px 3px 0px 0px !important; }
.align-center { text-align: center; }
.navbar-fixed-height { height: 32px; }
.icon-height { height: 20px; }
.title-margin { margin-top: auto; margin-bottom: auto; margin-right: 10px; }
.md-heigh { height: 64px; }
.pipe { color: #e85600; border-color: #e85600; }
.pipe:hover { background: #e85600; border-color: #e85600; }
iframe { border: 0px; width: 100%; height: 100% }
.resizer { display: flex; margin: 0; padding: 0; resize: vertical; overflow: hidden }
.resizer > .resized { flex-grow: 1; margin: 0; padding: 0; border: 0 }
.syntax-menu { right: 35px; }
.align-right { text-align: right; }
textarea {
margin: 5px;
font-family: Inconsolata;
background-color: inherit;
color: inherit;
line-height: 8px;
resize: none;
}
@font-face { font-family: 'Inconsolata'; src: URL('{{ .root }}static/inconsolata.ttf') format('truetype'); }
.spacing-top { margin: 3px 0px 0px 0px !important; }
.spacing-left { margin: 0px 3px 0px 0px !important; }
.align-center { text-align: center; }
.navbar-fixed-height { height: 32px; }
.icon-height { height: 20px; }
.title-margin { margin-top: auto; margin-bottom: auto; margin-right: 10px; }
.md-heigh { height: 64px; }
.pipe { color: #e85600; border-color: #e85600; }
.pipe:hover { background: #e85600; border-color: #e85600; }
iframe { border: 0px; width: 100%; height: 100% }
.resizer { display: flex; margin: 0; padding: 0; resize: vertical; overflow: hidden }
.resizer > .resized { flex-grow: 1; margin: 0; padding: 0; border: 0 }
.syntax-menu { right: 35px; }
.align-right { text-align: right; }
textarea {
margin: 5px;
font-family: Inconsolata;
background-color: inherit;
color: inherit;
line-height: 8px;
resize: none;
}
.button-help { width: 32px; float: left; }
.command-input { margin: 0px 0px 0px 36px; display: flex; width: calc(100% - 36px); min-width: 0; }
.modal-box { width: 100%; height: 100%; background-color: rgba(0, 0, 0, 0.8); }
.modal-search { width: 80%; height: 80%; margin: 10px; }
.modal-results { width: 100%; max-height: 500px; position: initial; overflow-y: scroll; overflow-x: hidden; }
.modal-results li { -webkit-user-select: text !important; -ms-user-select: text !important; user-select: text !important; }
.modal-name-big { font-size: 20px; }
.modal-name { color: #1447e6; font-weight: bold; font-family: Inconsolata; }
.modal-args { color: #178236; font-style: italic; font-family: Inconsolata; }
.modal-detail { width: 100%; margin: 10px 0px 0px 0px; }
.modal-entry { width: 100%; margin: 0px 0px 0px 20px; list-style: none; }
.modal-entry-text { min-width: 200px; display: inline-block; }
.modal-searchbar { width: calc(100% - 36px); }
.modal-close { float: right; width: 32px; }
</style>
<script>
function handle(obj) {
Expand Down Expand Up @@ -108,6 +122,114 @@
event.preventDefault();
}
}
{{ if $pipe }}
var rizinCmds = JSON.parse({{ .cmds | stringify }});
var rizinCmdsList = Object.keys(rizinCmds);
function openCmdHelp() {
var modal = document.getElementById("command-help");
modal.className += " active";
var search = document.getElementById("search-focus");
search.focus();
}
function closeCmdHelp() {
var modal = document.getElementById("command-help");
modal.className = modal.className.replace(" active", "");
}
function cmdAsText(parent, command) {
var details = (command.details || []);
var element = document.createElement('span');
element.className = "modal-name modal-name-big";
element.textContent = command.cmd;
parent.appendChild(element);

element = document.createElement('span');
element.className = "modal-args modal-name-big";
element.textContent = " " + command.args_str;
parent.appendChild(element);

if ((command.summary || "") != "") {
element = document.createElement('div');
element.textContent = command.summary.replace(".", ".\n");
parent.appendChild(element);
}
if ((command.description || "") != "") {
element = document.createElement('div');
element.textContent = command.description.replace(".", ".\n");
parent.appendChild(element);
}
for (var i = 0; i < details.length; i++) {
var entries = (details[i].entries || []);
var detail = document.createElement('ul');
detail.className = "modal-detail";
detail.textContent = details[i].name;
parent.appendChild(detail);
for (var i = 0; i < entries.length; i++) {
var entry = document.createElement('li');
entry.className = "modal-entry";
detail.appendChild(entry);

var text = document.createElement('span');
text.className = "modal-entry-text";
entry.appendChild(text);

if ((entries[i].text || "").length > 0) {
element = document.createElement('span');
element.className = "modal-name";
element.textContent = entries[i].text;
text.appendChild(element);
}

if ((entries[i].arg_str || "").length > 0) {
element = document.createElement('span');
element.className = "modal-args";
element.textContent = entries[i].arg_str;
text.appendChild(element);
}

if ((entries[i].comment || "").length > 0) {
element = document.createElement('span');
element.style.display = "inline-block";
element.textContent = " # " + entries[i].comment;
entry.appendChild(element);
}
}
}
}
function findCmd(element) {
var dropdown = document.getElementById("dropdown-results");
var results = document.getElementById("search-results");
results.innerHTML = "";
var tokens = element.value.split(/\s+/);
for (var i = 0, count = 0; i < rizinCmdsList.length; i++) {
var key = rizinCmdsList[i];
var descr = rizinCmds[key].description || "";
var summr = rizinCmds[key].summary || "";
var found = true;
for (var j = 0; j < tokens.length; j++) {
if (key.indexOf(tokens[j]) < 0 && descr.indexOf(tokens[j]) < 0 && summr.indexOf(tokens[j]) < 0) {
found = false;
break;
}
}
if (!found) {
continue;
}
var li = document.createElement('li');
if (count > 0) {
li.className = "divider";
results.appendChild(li);
li = document.createElement('li');
}
li.className = "menu-item";
cmdAsText(li, rizinCmds[key]);
results.appendChild(li);
count++;
}
if (dropdown.className.indexOf(" active") < 0) {
dropdown.className += " active";
}
}
{{ end }}
</script>
</head>
<body>
Expand Down Expand Up @@ -169,10 +291,27 @@
{{ if $pipe }}
&nbsp;
<a class="btn" href="#" onclick="newcm()"><i class="icon icon-resize-horiz">Command Line</i> Command Line</a>
&nbsp;
<a class="btn" href="#" onclick="openCmdHelp()"><i class="icon icon-search">Help</i> Help</a>
{{ end }}
</div>
</div>
</div>
{{ if $pipe }}
<div id="command-help" class="modal modal-box">
<div class="modal-content modal-search" onclick="" style="z-index: 999999;">
<div class="modal-body">
<div class="content">
<div class="dropdown" id="dropdown-results" style="width: 100%; height: 100%; max-height: 500px;">
<button class="btn btn-primary modal-close" onclick="closeCmdHelp()">&times;</button>
<input class="form-input modal-searchbar" id="search-focus" onchange="findCmd(this);" onkeypress="findCmd(this);" onpaste="findCmd(this);" oninput="findCmd(this);" value="" placeholder="Search for a command or keyword in a description"/>
<ul class="modal-results menu active" id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
{{ end }}
</section>
</section>
</body>
Expand Down
7 changes: 7 additions & 0 deletions notebook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ type Notebook struct {
pipes map[string]*Rizin
jsvm *JavaScript
rizin string
cmds map[string]RizinCommand
}

func NewNotebook(storage, rizinbin string) *Notebook {
Expand All @@ -71,6 +72,11 @@ func NewNotebook(storage, rizinbin string) *Notebook {
prefix := path.Join(storage) + string(os.PathSeparator)
suffix := string(os.PathSeparator) + PAGE_FILE

cmds, err := RizinCommands(rizinbin)
if err != nil {
panic(err)
}

files, err := filepath.Glob(path.Join(storage, "*", PAGE_FILE))
if err != nil {
panic(err)
Expand All @@ -95,6 +101,7 @@ func NewNotebook(storage, rizinbin string) *Notebook {
pipes: map[string]*Rizin{},
jsvm: jsvm,
rizin: rizinbin,
cmds: cmds,
}
}

Expand Down
58 changes: 58 additions & 0 deletions pipe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,44 @@ package main
import (
"bufio"
"bytes"
"encoding/json"
"fmt"
"io"
"os/exec"
"strings"
"sync"
)

type RizinCommandArg struct {
Type string `json:"type"`
Name string `json:"name"`
DefaultArg string `json:"default,omitempty"`
Required bool `json:"required,omitempty"`
IsOption bool `json:"is_option,omitempty"`
IsArray bool `json:"is_array,omitempty"`
Choices []string `json:"choices,omitempty"`
}

type RizinCommandDetailEntry struct {
Text string `json:"text,omitempty"`
Comment string `json:"comment,omitempty"`
Arg string `json:"arg_str,omitempty"`
}

type RizinCommandDetail struct {
Name string `json:"name"`
Entries []RizinCommandDetailEntry `json:"entries,omitempty"`
}

type RizinCommand struct {
Command string `json:"cmd"`
ArgsStr string `json:"args_str"`
Args []RizinCommandArg `json:"args,omitempty"`
Description string `json:"description,omitempty"`
Summary string `json:"summary,omitempty"`
Details []RizinCommandDetail `json:"details,omitempty"`
}

type Rizin struct {
pipe *exec.Cmd
stdin io.WriteCloser
Expand All @@ -26,6 +57,17 @@ func RizinInfo(rizinbin string) ([]string, error) {
return strings.Split(string(out), "\n"), nil
}

func RizinCommands(rizinbin string) (map[string]RizinCommand, error) {
out, err := exec.Command(rizinbin, "-qc", "?*j").Output()
if err != nil {
return nil, err
}

var commands map[string]RizinCommand
err = json.Unmarshal(out, &commands)
return commands, err
}

func NewRizin(rizinbin, file, project string) *Rizin {
args := []string{
"-2",
Expand Down Expand Up @@ -67,6 +109,22 @@ func NewRizin(rizinbin, file, project string) *Rizin {
return rizin
}

func (r *Rizin) getCommands(cmd string) (string, error) {
r.mutex.Lock()
defer r.mutex.Unlock()
if _, err := fmt.Fprintln(r.stdin, cmd); err != nil {
fmt.Println("pipe error:", err)
return "", err
}
buf, err := bufio.NewReader(r.stdout).ReadString('\x00')
if err != nil && err != io.EOF {
fmt.Println("pipe error:", err)
return "", err
}
buf = string(bytes.Trim([]byte(buf), "\x00"))
return buf, nil
}

func (r *Rizin) exec(cmd string) (string, error) {
r.mutex.Lock()
defer r.mutex.Unlock()
Expand Down
31 changes: 17 additions & 14 deletions server_page.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,10 @@ func serverAddPage(root *gin.RouterGroup) {
"root": webroot,
"error": "cannot find page",
})
} else {
c.Redirect(302, webroot)
return
}

c.Redirect(302, webroot)
})
root.GET("/edit/:unique", func(c *gin.Context) {
unique := c.Param("unique")
Expand All @@ -89,13 +90,13 @@ func serverAddPage(root *gin.RouterGroup) {
"root": webroot,
"error": "cannot find page",
})
} else {
c.HTML(200, "page-new.tmpl", gin.H{
"root": webroot,
"title": page["title"],
"unique": unique,
})
return
}
c.HTML(200, "page-new.tmpl", gin.H{
"root": webroot,
"title": page["title"],
"unique": unique,
})
})
root.GET("/view/:unique", func(c *gin.Context) {
unique := c.Param("unique")
Expand All @@ -105,12 +106,14 @@ func serverAddPage(root *gin.RouterGroup) {
"root": webroot,
"error": "cannot find a new page",
})
} else {
c.HTML(200, "page-view.tmpl", gin.H{
"root": webroot,
"page": page,
"pipe": notebook.open(unique, false) != nil,
})
return
}

c.HTML(200, "page-view.tmpl", gin.H{
"root": webroot,
"page": page,
"pipe": notebook.open(unique, false) != nil,
"cmds": notebook.cmds,
})
})
}