widgets.lua

-- Grab environment.
local awful     = require("awful")
local beautiful = require("beautiful")
local io        = require("io")
local os        = require("os")
local wibox     = require("wibox")
local util      = require("vain.util")
local timer     = timer
local string    = string
local image     = image
local math      = math
local pairs     = pairs
local tonumber  = tonumber
local type      = type
local capi      = { wibox = wibox }
local table     = table

module("vain.widgets")

-- Global variables
terminal       = "xterm"
fg_focus       = beautiful.fg_focus or "#FFFFFF"
fg_urgent      = beautiful.fg_urgent or "#FFFFFF"
vain_dir       = os.getenv("HOME") .. "/.config/awesome/vain"
icons_dir      = vain_dir .. "/themes/default/icons"
control_volume = vain_dir .. "/scripts/control_volume"

-- If vain.terminal is a string, e.g. "xterm", then "xterm -e " .. cmd is
-- run. But if vain.terminal is a function, then terminal(cmd) is run.
local function run_in_terminal(cmd)
    if type(terminal) == "function"
    then
        terminal(cmd)
    elseif type(terminal) == "string"
    then
        awful.util.spawn(terminal .. ' -e ' .. cmd)
    end
end

-- System load
function systemload(args)
    local args = args or {}
    local refresh_timeout = args.refresh_timeout or 10
    local show_all = args.show_all or false

    local mysysload = wibox.widget.textbox()
    local mysysloadupdate = function()
        local f = io.open("/proc/loadavg")
        local ret = f:read("*all")
        f:close()

        if show_all
        then
            local a, b, c = string.match(ret, "([^%s]+) ([^%s]+) ([^%s]+)")
            mysysload:set_text(string.format("%s %s %s", a, b, c))
        else
            local a = string.match(ret, "([^%s]+) ")
            mysysload:set_text(string.format("%s", a))
        end
        mysysload:set_markup(' <span color="' .. fg_urgent .. '">'
                         .. mysysload._layout.text .. '</span> ')
    end
    mysysloadupdate()
    local mysysloadtimer = timer({ timeout = refresh_timeout })
    mysysloadtimer:connect_signal("timeout", mysysloadupdate)
    mysysloadtimer:start()
    mysysload:buttons(awful.util.table.join(
        awful.button({}, 0,
            function()
                run_in_terminal('htop')
            end)
    ))
    return mysysload
end

cpuusage_lasttotal = 0
cpuusage_lastactive = 0
function cpuusage(args)
    local args = args or {}
    local refresh_timeout = args.refresh_timeout or 10

    local w = wibox.widget.textbox()

    local readcurrent = function()
        -- Read the amount of time the CPUs have spent performing
        -- different kinds of work. Read the first line of /proc/stat
        -- which is the sum of all CPUs.
        local times = util.first_line("/proc/stat")
        local at = 1
        local idle = 0
        local total = 0
        for field in string.gmatch(times, "[%s]+([^%s]+)")
        do
            -- 3 = idle, 4 = ioWait. Essentially, the CPUs have done
            -- nothing during these times.
            if at == 3 or at == 4
            then
                idle = idle + field
            end
            total = total + field
            at = at + 1
        end
        local active = total - idle

        return active, total
    end

    local cpuusageupdate = function()
        -- Read current data and calculate relative values.
        local nowactive, nowtotal = readcurrent()
        local dactive = nowactive - cpuusage_lastactive
        local dtotal = nowtotal - cpuusage_lasttotal
        w:set_markup(' cpu: '
                     .. '<span color="' .. fg_focus .. '">'
                     .. string.format('%3s', math.ceil((dactive / dtotal) * 100))
                     .. '%'
                     .. '</span>'
                     .. ' ')

        -- Save current data for the next run.
        cpuusage_lastactive = nowactive
        cpuusage_lasttotal = nowtotal
    end

    -- Record current (first) data.
    cpuusage_lastactive, cpuusage_lasttotal = readcurrent()

    -- Set up timer, buttons and initial text.
    local cpuusagetimer = timer({ timeout = refresh_timeout })
    cpuusagetimer:connect_signal("timeout", cpuusageupdate)
    cpuusagetimer:start()
    w:buttons(awful.util.table.join(
        awful.button({}, 0,
            function()
                run_in_terminal('htop')
            end)
    ))
    w:set_markup(' cpu: '
                 .. '<span color="' .. fg_focus .. '">'
                 .. '  0%'
                 .. '</span>'
                 .. ' ')
    return w
end

-- Show memory usage (ignoring caches)
function memusage(args)
    local args = args or {}
    local refresh_timeout = args.refresh_timeout or 10
    local show_swap = args.show_swap or false

    local widg = wibox.widget.textbox()

    local upd = function()
        -- Get MEM info. Base code borrowed from Vicious.
        -- Note to self: Numbers in meminfo are KiB although it says kB.
        -- Actually, I'd like to use MB rather than MiB, but `htop` uses
        -- MiB, too, so I'll keep it consistent.
        local mem = {}
        for line in io.lines("/proc/meminfo")
        do
            for k, v in string.gmatch(line, "([%a]+):[%s]+([%d]+).+")
            do
                if     k == "MemTotal"  then mem.total = math.floor(v / 1024)
                elseif k == "MemFree"   then mem.free  = math.floor(v / 1024)
                elseif k == "Buffers"   then mem.buf   = math.floor(v / 1024)
                elseif k == "Cached"    then mem.cache = math.floor(v / 1024)
                elseif k == "SwapTotal" then mem.swap  = math.floor(v / 1024)
                elseif k == "SwapFree"  then mem.swapf = math.floor(v / 1024)
                end
            end
        end

        used = mem.total - (mem.free + mem.buf + mem.cache)
        swapused = mem.swap - mem.swapf
        fmt = "%" .. string.len(mem.total) .. ".0f/%.0f MB"
        widg:set_markup(' <span color="' .. fg_urgent .. '">'
                         .. string.format(fmt, used, mem.total) .. '</span> ')

        if show_swap
        then
            widg:set_markup(widg._layout.text .. '('
                            .. string.format('%.0f MB', swapused)
                            .. ') ')
        end
    end
    upd()
    local tmr = timer({ timeout = refresh_timeout })
    tmr:connect_signal("timeout", upd)
    tmr:start()
    widg:buttons(awful.util.table.join(
        awful.button({}, 0,
            function()
                run_in_terminal('htop')
            end)
    ))
    return widg
end

-- Maildir check
function mailcheck(args)
    local args = args or {}
    -- better setting it by beautiful
    local mailpath = args.mailpath or os.getenv("HOME") .. "/Mail"
    local ignore_boxes = args.ignore_boxes or {}
    local refresh_timeout = args.refresh_timeout or 30

    local mymailcheck = wibox.widget.textbox()
    local mymailcheckupdate = function()
        -- Find pathes to mailboxes.
        local p = io.popen("find " .. mailpath ..
                           " -mindepth 1 -maxdepth 1 -type d" ..
                           " -not -name .git")
        local boxes = {}
        local line = ""
        repeat
            line = p:read("*l")
            if line ~= nil
            then
                -- Find all files in the "new" subdirectory. For each
                -- file, print a single character (no newline). Don't
                -- match files that begin with a dot.
                -- Afterwards the length of this string is the number of
                -- new mails in that box.
                local np = io.popen("find " .. line ..
                                    "/new -mindepth 1 -type f " ..
                                    "-not -name '.*' -printf a")
                local mailstring = np:read("*all")

                -- Strip off leading mailpath.
                local box = string.match(line, mailpath .. "/*([^/]+)")
                local nummails = string.len(mailstring)
                if nummails > 0
                then
                    boxes[box] = nummails
                end
            end
        until line == nil

        table.sort(boxes)

        local newmail = ""
        for box, number in pairs(boxes)
        do
            -- Add this box only if it's not to be ignored.
            if not util.element_in_table(box, ignore_boxes)
            then
                if newmail == ""
                then
                    newmail = box .. "(" .. number .. ")"
                else
                    newmail = newmail .. ", " ..
                              box .. "(" .. number .. ")"
                end
            end
        end

        if newmail == ""
        then
            mymailcheck:set_text(' no mail ')
        else
            mymailcheck:set_markup(' <span color="'
                                     .. (beautiful.mailcheck_new or "#FF0000")
                                     .. '">mail: ' .. newmail .. '</span> ')
        end
    end
    if args.initial_update == nil or args.initial_update
    then
        mymailcheckupdate()
    else
        mymailcheck:set_text(' no mail ')
    end
    local mymailchecktimer = timer({ timeout = refresh_timeout })
    mymailchecktimer:connect_signal("timeout", mymailcheckupdate)
    mymailchecktimer:start()
    mymailcheck:buttons(awful.util.table.join(
        awful.button({}, 0,
            function()
                run_in_terminal('bash -i -c smail')
            end)
    ))
    return mymailcheck
end

-- Battery
function battery(args)
    local args = args or {}
    local bat = args.battery or "BAT0"
    local refresh_timeout = args.refresh_timeout or 30

    local mybattery = wibox.widget.textbox()
    local mybatteryupdate = function()

        local first_line = util.first_line
        local present = first_line("/sys/class/power_supply/" .. bat ..
                                   "/present")
        if present == "1"
        then
            local rate = first_line("/sys/class/power_supply/" .. bat ..
                                    "/current_now")
            local ratev = first_line("/sys/class/power_supply/" .. bat ..
                                     "/voltage_now")
            local rem = first_line("/sys/class/power_supply/" .. bat ..
                                   "/charge_now")
            local tot = first_line("/sys/class/power_supply/" .. bat ..
                                   "/charge_full")
            local status = first_line("/sys/class/power_supply/" .. bat ..
                                      "/status")

            local time_rat = 0
            if status == "Charging"
            then
                status = "(+)"
                time_rat = (tot - rem) / rate
            elseif status == "Discharging"
            then
                status = "(-)"
                time_rat = rem / rate
            else
                status = "(.)"
            end

            local hrs = math.floor(time_rat)
            local min = (time_rat - hrs) * 60
            local time = string.format("%02d:%02d", hrs, min)

            local perc = string.format("%d%%", (rem / tot) * 100)

            local watt = string.format("%.2fW", (rate * ratev) / 1e12)

            text = watt .. " " .. perc .. " " .. time .. " " .. status
        else
            text = "no battery"
        end

        mybattery:set_markup(' <span color="' .. fg_urgent .. '">'
                             .. text .. '</span> ')
    end
    mybatteryupdate()
    local mybatterytimer = timer({ timeout = refresh_timeout })
    mybatterytimer:connect_signal("timeout", mybatteryupdate)
    mybatterytimer:start()
    return mybattery
end

-- Volume
function volume(args)
    local args = args or {}
    local mixer_channel = args.mixer_channel or "Master"
    local refresh_timeout = args.refresh_timeout or 2

    local myvolume = wibox.widget.textbox()
    local myvolumeupdate = function()
        -- Mostly copied from vicious.
        local f = io.popen(control_volume .. ' get ' .. mixer_channel)
        local mixer = f:read("*all")
        f:close()

        local volu, mute = string.match(mixer, "(%d+) (%l+)")

        if volu == nil
        then
            volu = 0
        end

        if mute == nil
        then
            mute = "---"
        elseif mute == 'on'
        then
            mute = 'O'
        else
            mute = 'M'
        end

        local ret = string.format("%03d%% %s", volu, mute)
        myvolume:set_markup(' <span color="' .. fg_urgent .. '">'
                            .. ret .. '</span> ')
    end
    myvolumeupdate()
    local myvolumetimer = timer({ timeout = refresh_timeout })
    myvolumetimer:connect_signal("timeout", myvolumeupdate)
    myvolumetimer:start()
    myvolume:buttons(awful.util.table.join(
        awful.button({}, 1,
            function()
                os.execute(control_volume .. ' toggle ' .. mixer_channel)
             end),

        awful.button({}, 2,
            function()
                run_in_terminal('alsamixer')
            end),

        awful.button({}, 3,
            function()
                os.execute(control_volume .. ' toggle ' .. mixer_channel)
            end),

        awful.button({}, 4,
            function()
                os.execute(control_volume .. ' up ' ..  mixer_channel)
            end),

        awful.button({}, 5,
            function()
                os.execute(control_volume .. ' down ' .. mixer_channel)
            end)
    ))
    return myvolume
end

-- MPD
-- TODO: unify the array in a 'single box' widget
function mpd(args)
    local args = args or {}
    local mixer_channel = args.mixer_channel or "Master"

    local mpdtable = {
        wibox.widget.textbox(),
        wibox.widget.imagebox(),
        wibox.widget.imagebox(),
        wibox.widget.imagebox(),
        wibox.widget.imagebox(),
        wibox.widget.textbox()
    }

    if args.show_label == nil or args.show_label
    then
        mpdtable[1].text = " mpd: "
    else
        mpdtable[1].text = " "
    end

    -- TODO: add beautiful defined icons option 
    mpdtable[2]:set_image(icons_dir .. "/rwd.png")
    mpdtable[2]:set_image(icons_dir .. "/stop.png")
    mpdtable[2]:set_image(icons_dir .. "/play.png")
    mpdtable[2]:set_image(icons_dir .. "/fwd.png")
    mpdtable[6]:set_text(" ")

    local function buttons_for_mpdwidget(widg, cmd)
        widg:buttons(awful.util.table.join(
            awful.button({}, 1, function() awful.util.spawn(cmd) end),

            awful.button({}, 2,
                function()
                    run_in_terminal('ncmpcpp')
                end),

            awful.button({}, 3,
               function()
                    os.execute(control_volume .. ' toggle ' .. mixer_channel)
               end),

            awful.button({}, 4,
               function()
                   os.execute(control_volume .. ' up ' ..  mixer_channel)
               end),

            awful.button({}, 5,
               function()
                   os.execute(control_volume .. ' down ' .. mixer_channel)
               end)
        ))
    end
    buttons_for_mpdwidget(mpdtable[2], 'mpc prev')
    buttons_for_mpdwidget(mpdtable[3], 'mpc stop')
    buttons_for_mpdwidget(mpdtable[4], 'mpc toggle')
    buttons_for_mpdwidget(mpdtable[5], 'mpc next')
    return mpdtable
end

-- Net
net_last_t = {}
net_last_r = {}

function net(args)
    local args = args or {}
    local iface = args.iface or "eth0"
    local delta = args.refresh_timeout or 2

    local mynet = wibox.widget.textbox()
    local mynetupdate = function()
        local state = util.first_line('/sys/class/net/' .. iface ..
                                           '/operstate')
        local now_t = util.first_line('/sys/class/net/' .. iface ..
                                           '/statistics/tx_bytes')
        local now_r = util.first_line('/sys/class/net/' .. iface ..
                                           '/statistics/rx_bytes')
        local text = iface .. ': '

        if state == 'down' or not now_t or not now_r
        then
            mynet:set_text(' ' .. text .. '-' .. ' ')
            return
        end

        if net_last_t[iface] and net_last_t[iface]
        then
            local val = ((now_t - net_last_t[iface]) / delta / 1e3)
            text = text
                   .. '<span color="' .. fg_focus .. '">'
                   .. '↑('
                   .. util.paddivnum(val, 5, 1)
                   .. ')'
                   .. '</span>'

            text = text .. ', '

            val = ((now_r - net_last_r[iface]) / delta / 1e3)
            text = text
                   .. '<span color="' .. fg_urgent .. '">'
                   .. '↓('
                   .. util.paddivnum(val, 5, 1)
                   .. ')'
                   .. '</span>'

            mynet:set_markup(' ' .. text .. ' ')
        else
            mynet:set_markup(' ' .. text .. '-' .. ' ')
        end

        net_last_t[iface] = now_t
        net_last_r[iface] = now_r
    end
    mynetupdate()
    local mynettimer = timer({ timeout = delta })
    mynettimer:connect_signal("timeout", mynetupdate)
    mynettimer:start()
    return mynet
end

-- Integration of "gitodo".
-- See: https://github.com/vain/gitodo
-- Shows the number of open tasks. On click, a terminal is spawned which
-- first shows all those tasks and then launches a shell for you to work
-- with gitodo.
function gitodo(args)
    local args = args or {}
    local widg = wibox.widget.textbox()
    local refresh_timeout = args.refresh_timeout or 120

    local mytodoupdate = function()
        local f = io.popen("gitodo --count")
        local ret = f:read("*all")
        f:close()

        local outdated, warning, all = string.match(ret,
                                                    "(%d+) (%d+) (%d+)")

        local msg = ' todo: '

        -- Let's avoid to crash in any case
        if outdated == nil or warning == nil or all == nil
        then
            widg:set_text('nil')
            return widg
        end

        if tonumber(outdated) > 0
        then
            msg = msg .. '<span color="'
                      .. (beautiful.gitodo_outdated or beautiful.border_focus)
                      .. '">'
                      .. outdated
                      .. '</span>, '
        end

        if tonumber(warning) > 0
        then
            msg = msg .. '<span color="'
                      .. (beautiful.gitodo_warning or fg_urgent)
                      .. '">'
                      .. warning
                      .. '</span>, '
        end

        msg = msg .. '<span color="'
                  .. (beautiful.gitodo_normal or fg_urgent)
                  .. '">'
                  .. all
                  .. '</span> '

        widg:set_markup(msg)
    end
    if args.initial_update == nil or args.initial_update
    then
        mytodoupdate()
    else
        widg:set_text(' todo: - ')
    end
    local todotimer = timer({ timeout = refresh_timeout })
    todotimer:connect_signal("timeout", mytodoupdate)
    todotimer:start()

    widg:buttons(awful.util.table.join(
        awful.button({}, 0,
            function()
                run_in_terminal('bash -c "gitodo --raw | '
                                .. 'cut -d\\" \\" -f2 | highcal; '
                                .. 'echo; gitodo; echo; exec bash"')
            end)
    ))

    return widg
end

-- Creates a thin wibox at a position relative to another wibox.
-- Note: It is vital that we use capi.wibox instead of awful.wibox. The
-- awful library will do additional stuff that we certainly do not want
-- to be done here.
function borderbox(relbox, s, args)
    local wiboxarg = {}
    local where = args.position or 'above'
    local color = args.color or '#FFFFFF'
    local size = args.size or 1
    local box = nil
    wiboxarg.position = nil
    wiboxarg.bg = color

    if where == 'above'
    then
        wiboxarg.width = relbox.width
        wiboxarg.height = size
        box = capi.wibox(wiboxarg)
        box.x = relbox.x
        box.y = relbox.y - size
    elseif where == 'below'
    then
        wiboxarg.width = relbox.width
        wiboxarg.height = size
        box = capi.wibox(wiboxarg)
        box.x = relbox.x
        box.y = relbox.y + relbox.height
    elseif where == 'left'
    then
        wiboxarg.width = size
        wiboxarg.height = relbox.height
        box = capi.wibox(wiboxarg)
        box.x = relbox.x - size
        box.y = relbox.y
    elseif where == 'right'
    then
        wiboxarg.width = size
        wiboxarg.height = relbox.height
        box = capi.wibox(wiboxarg)
        box.x = relbox.x + relbox.width
        box.y = relbox.y
    end

    box.screen = s
    return box
end

-- vim: set et :