uva-node

UVa Command Line Tool

npm install uva-node
10 downloads in the last week
22 downloads in the last month

Command line tool for the UVa Online Judge website

UVA-NODE is an interactive shell where you can type commands to submit and check your submissions.

Features

  • new Opens questions in browser!
  • Remembers your account info and encrypts your passwords.
  • Password-less submissions.
  • Checks most recent submission status.
  • Template Support!
  • File name completion and problem number detection
  • Non-interactive mode
  • Cross-platform: Linux, Mac OS X, Windows or whatever node.js runs on

One-time setup:

> tpl add path/to/template.cpp 

> set-editor vim
Editor set

> add uva john.doe my-secret-password
Account added

> use uva john.doe
Account set as current

> tpl show
lang     | file path
C++        path/to/template.cpp

> set-browser "path to browser"
Browser set

Sample usage:

> view 123
... opens browser to show problem 123 ...

> edit 123.cpp
.... spawn the template and launch vim ....
Edit done

> send 123
Inferred Problem #: 123
       Source file: 123.cpp
Logging in...
Sending code...
Sent OK

> stat
Getting status...
Sub Id    | Prob # |      Verdict     |  Lang  | Runtime |  Rank |      Sub Time
 11638387      123           accepted      C++     0.008     519   2013-04-20 13:35:04
 11629565      125           accepted      C++     0.016     900   2013-04-19 00:16:01
...

Non-interactive usage:

lucastan$ node uva-node status
Getting status...
Sub Id    | Prob # |      Verdict     |  Lang  | Runtime |  Rank |      Sub Time
 11638387      123           accepted      C++     0.008     519   2013-04-20 13:35:04
 11629565      125           accepted      C++     0.016     900   2013-04-19 00:16:01

lucastan$

Requirements

To run, you'd need node.js v0.10.0 and above. An older version might work although it has been tested only with v0.10.0

To check your node.js version, do node --version at the command line.

Running

3 simple steps! No building required!

  1. Install node.js if you haven't: http://nodejs.org
  2. git clone https://github.com/lucastan/uva-node.git (recommended) or download the source https://github.com/lucastan/uva-node/archive/master.zip
  3. node uva-node

The program will generate a settings file and a random key file the first time it is run. Please do not modify them manually.

It will use the key to encrypt all your account passwords. The key is stored at ~/.ssh/uva-node.key where ~ is your home directory. You don't have to generate an SSH key nor will the program use your SSH key. Settings are saved in the JSON format at ~/.uva-node.

To upgrade to the latest version, simply do git pull in the uva-node dir!

There is an older version (uva-cli) written in Java at uva-cli.git, but only this node.js version will be actively maintained.

Usage

UVA-NODE is an interactive shell (REPL) in which you can type commands of the syntax: <action> <arg1> <arg2> ...

Each arg can be surrounded by quotes if there are spaces in it. For example, "/path/with spaces/" or '/path/with spaces/'. You can use either double or single quote, but must be matching.

Quotes cannot be used for the add action as your password might contain quotes.

For your convenience, the program will in many cases auto-detect the language based on the file name extension:

Ext. Lang
.java Java
.cpp / .cc C++
.c C
.pascal / .pas / .p Pascal

The following are possible actions:

tpl

Syntax:

  • tpl add {filePath}
  • tpl remove {lang}
  • tpl show

All template settings are global across your accounts, but still specific to the OS user (computer user).

tpl add {filePath}:

  • Adds or replaces an existing template path. The program will merely store the file path, and will not copy the template file to another place. This behavior ensures the program always use the latest version of your template without having you to re-add.
  • It is recommended that filePath is absolute, instead of relative, to avoid path issues, and make it independent of where you launch uva-node.
  • Will detect language based on file extension.
  • The file must be in the UTF-8 or ASCII encoding. If you have no clue what it is, don't worry about it.
  • In the template file, put the string $caret_start$ in a line of its own at where you want to start typing the code.
    The entire line containing $caret_start$ will be replaced with a blank line.

Sample template file:

#include <stdio.h>

int main()
{
    $caret_start$
    return 0;
}

tpl remove {lang}:

  • Removes the template path but will not delete the template file.
  • {lang} is cpp / c / java / pascal / pas / p.

tpl show:

  • Shows all template settings.

set-editor

Syntax: set-editor {path to editor}

Sets editor command. Usually vim or vi. Actually any editor will do. Try experimenting on your own. Only vi / vim is tested with.

If the command is relative, it must exist in one of the paths specified by the $PATH environment variable.

If the path contains spaces, please surround with quotes like this "/path/Program 123"

Windows users:

  • If you are using Git bash shell, you can use something like "C:\program files\Git\share\vim\vim73\vim.exe".

  • If you are using MinGW, you could use a path such as C:\MinGW\msys\1.0\bin\vim.exe

  • If you do not want to use absolute paths, you can simply use vim.exe but please ensure it is in your PATH environment variable.

  • It is also possible to use a GUI-based editor such as gvim

edit

Syntax: edit {srcFilePath}

If {srcFilePath} does not exist, and there is a template configured for the language, the program will spawn the template and launch the editor. If there is no template, a blank file will be created instead.

Otherwise, if {srcFilePath} exists, the program will launch the editor only.

add

Syntax: add {type} {username} {password}

Adds a new user account, or replace an existing one with the same type and username. The replacing behavior is useful for updating password.

All accounts will be preserved even after you quit the program.

Currently uva is the only supported type.

remove

Syntax: remove {type} {username}

Removes a user account. You cannot remove an account that is set as current.

use

Syntax: use {type} {username} OR use

Sets a user account as current. If both {type} and {username} are omitted, sets the current account to none. The current account setting will be preserved even after you quit the program.

show

Syntax: show

Shows all user accounts

send

Syntax: send {problem #} {fileName/Path} OR send {fileName/Path} OR send {problem #}

Sends a code file using the current account. {fileName/Path} is relative to the current directory, which is where you ran the node ... command to start uva-node

The program will auto-detect the language using the file name extension.

If only {problem #} is specified, the program will detect the source file in the current directory whose name contains the {problem #}. For example, if there is an existing file 00123.cpp and you specify the problem # as 123, the program will assume you want to send 00123.cpp (leading zeroes are ignored). If multiple files are found to contain the problem # in their names, the program will abort sending. For example, if there are files 123-a.cpp and 123.cpp, the program will not be able to know which one you want to send. In this case, you'd have to specify both the {problem #} and {fileName} args.

If only {fileName/Path} is specified, the program will infer the problem # from the file name. The problem # is assumed to be the first integer found in the file name, ignoring leading zeroes.

status / stat

Syntax: status/stat {count}

Prints out the latest {count} submissions for the current account. {count} defaults to 10 if omitted.

set-browser

Syntax: set-browser {path} [{arg1} {arg2} ...]

Sets the command for opening the browser to view a question. Args are optional.

If the path or args contains spaces, please surround with quotes.

Mac OS users:

  • You may want to use the "open" tool which will open in your default browser. For example, set-browser open.

get-browser

Syntax: get-browser

Prints out the browser command including args.

view

Syntax: view {prob #}

Opens the problem webpage in the browser.

quit / exit

Saves all settings including account info and exits the program.

More features coming soon

  • Log in only once instead of logging in on every send
  • Supports more coding websites
  • Auto-retry submitting the solution (when UVA is down)
  • Connects to UVAtoolkit
  • Get statistics on a problem

Credits

  • UVA website
  • uHunt API
  • node.js

License

I have yet to decide on a license to apply to the source code. Meanwhile, I reserve all copyrights.

Please let me know if there is any problem!

npm loves you