// fluxbox-update_configs.cc // Copyright (c) 2007 Fluxbox Team (fluxgen at fluxbox dot org) // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. #include "../src/FbTk/I18n.hh" #include "../src/FbTk/Resource.hh" #include "../src/FbTk/StringUtil.hh" #include "../src/FbTk/FileUtil.hh" #include "../src/defaults.hh" #ifdef HAVE_SIGNAL_H #include #endif // HAVE_SIGNAL_H #include #include #include #include #include #include #include #include using std::cout; using std::cerr; using std::endl; using std::string; using std::ifstream; using std::ofstream; using std::set; using std::map; using std::list; using std::exit; string read_file(const string& filename); void write_file(const string& filename, const string &contents); void save_all_files(); /*------------------------------------------------------------------*\ \*------------------------------------------------------------------*/ void update_add_mouse_evens_to_keys(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); string new_keyfile = ""; // let's put our new keybindings first, so they're easy to find new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; new_keyfile += "OnDesktop Mouse1 :HideMenus\n"; new_keyfile += "OnDesktop Mouse2 :WorkspaceMenu\n"; new_keyfile += "OnDesktop Mouse3 :RootMenu\n"; // scrolling on desktop needs to match user's desktop wheeling settings // hmmm, what are the odds that somebody wants this to be different on // different screens? the ability is going away until we make per-screen // keys files, anyway, so let's just use the first screen's setting FbTk::Resource rc_wheeling(rm, true, "session.screen0.desktopwheeling", "Session.Screen0.DesktopWheeling"); FbTk::Resource rc_reverse(rm, false, "session.screen0.reversewheeling", "Session.Screen0.ReverseWheeling"); if (*rc_wheeling) { if (*rc_reverse) { // if you ask me, this should have been default new_keyfile += "OnDesktop Mouse4 :PrevWorkspace\n"; new_keyfile += "OnDesktop Mouse5 :NextWorkspace\n"; } else { new_keyfile += "OnDesktop Mouse4 :NextWorkspace\n"; new_keyfile += "OnDesktop Mouse5 :PrevWorkspace\n"; } } new_keyfile += "\n"; // just for good looks new_keyfile += whole_keyfile; // don't forget user's old keybindings write_file(keyfilename, new_keyfile); } void update_move_groups_entries_to_apps_file(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { FbTk::Resource rc_groupfile(rm, "~/.fluxbox/groups", "session.groupFile", "Session.GroupFile"); string groupfilename = FbTk::StringUtil::expandFilename(*rc_groupfile); string whole_groupfile = read_file(groupfilename); string whole_appsfile = read_file(appsfilename); string new_appsfile = ""; list lines; FbTk::StringUtil::stringtok(lines, whole_groupfile, "\n"); list::iterator line_it = lines.begin(); list::iterator line_it_end = lines.end(); for (; line_it != line_it_end; ++line_it) { new_appsfile += "[group] (workspace=[current])\n"; list apps; FbTk::StringUtil::stringtok(apps, *line_it); list::iterator it = apps.begin(); list::iterator it_end = apps.end(); for (; it != it_end; ++it) { new_appsfile += " [app] (name="; new_appsfile += *it; new_appsfile += ")\n"; } new_appsfile += "[end]\n"; } new_appsfile += whole_appsfile; write_file(appsfilename, new_appsfile); } void update_move_toolbar_wheeling_to_keys_file(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); string new_keyfile = ""; // let's put our new keybindings first, so they're easy to find new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; bool keep_changes = false; // scrolling on toolbar needs to match user's toolbar wheeling settings FbTk::Resource rc_wheeling(rm, "Off", "session.screen0.iconbar.wheelMode", "Session.Screen0.Iconbar.WheelMode"); FbTk::Resource rc_screen(rm, true, "session.screen0.desktopwheeling", "Session.Screen0.DesktopWheeling"); FbTk::Resource rc_reverse(rm, false, "session.screen0.reversewheeling", "Session.Screen0.ReverseWheeling"); if (strcasecmp((*rc_wheeling).c_str(), "On") == 0 || (strcasecmp((*rc_wheeling).c_str(), "Screen") == 0 && *rc_screen)) { keep_changes = true; if (*rc_reverse) { // if you ask me, this should have been default new_keyfile += "OnToolbar Mouse4 :PrevWorkspace\n"; new_keyfile += "OnToolbar Mouse5 :NextWorkspace\n"; } else { new_keyfile += "OnToolbar Mouse4 :NextWorkspace\n"; new_keyfile += "OnToolbar Mouse5 :PrevWorkspace\n"; } } new_keyfile += "\n"; // just for good looks new_keyfile += whole_keyfile; // don't forget user's old keybindings if (keep_changes) write_file(keyfilename, new_keyfile); } void update_move_modkey_to_keys_file(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); string new_keyfile = ""; // let's put our new keybindings first, so they're easy to find new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; // need to match user's resize model FbTk::Resource rc_mode(rm, "Bottom", "session.screen0.resizeMode", "Session.Screen0.ResizeMode"); FbTk::Resource rc_modkey(rm, "Mod1", "session.modKey", "Session.ModKey"); new_keyfile += "OnWindow " + *rc_modkey + " Mouse1 :MacroCmd {Raise} {Focus} {StartMoving}\n"; new_keyfile += "OnWindow " + *rc_modkey + " Mouse3 :MacroCmd {Raise} {Focus} {StartResizing "; if (strcasecmp((*rc_mode).c_str(), "Quadrant") == 0) { new_keyfile += "NearestCorner}\n"; } else if (strcasecmp((*rc_mode).c_str(), "Center") == 0) { new_keyfile += "Center}\n"; } else { new_keyfile += "BottomRight}\n"; } new_keyfile += "\n"; // just for good looks new_keyfile += whole_keyfile; // don't forget user's old keybindings write_file(keyfilename, new_keyfile); } void update_window_patterns_for_iconbar(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { // this needs to survive after going out of scope // it won't get freed, but that's ok FbTk::Resource *rc_mode = new FbTk::Resource(rm, "Workspace", "session.screen0.iconbar.mode", "Session.Screen0.Iconbar.Mode"); std::string mode = FbTk::StringUtil::toLower(**rc_mode); if (mode == "none") *rc_mode = "none"; else if (mode == "icons") *rc_mode = "{static groups} (minimized=yes)"; else if (mode == "noicons") *rc_mode = "{static groups} (minimized=no)"; else if (mode == "workspaceicons") *rc_mode = "{static groups} (minimized=yes) (workspace)"; else if (mode == "workspacenoicons") *rc_mode = "{static groups} (minimized=no) (workspace)"; else if (mode == "allwindows") *rc_mode = "{static groups}"; else *rc_mode = "{static groups} (workspace)"; } void update_move_titlebar_actions_to_keys_file(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); string new_keyfile = ""; // let's put our new keybindings first, so they're easy to find new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; new_keyfile += "OnTitlebar Double Mouse1 :Shade\n"; new_keyfile += "OnTitlebar Mouse3 :WindowMenu\n"; FbTk::Resource rc_reverse(rm, false,"session.screen0.reversewheeling", "Session.Screen0.ReverseWheeling"); FbTk::Resource scroll_action(rm, "", "session.screen0.windowScrollAction", "Session.Screen0.WindowScrollAction"); if (strcasecmp((*scroll_action).c_str(), "shade") == 0) { if (*rc_reverse) { new_keyfile += "OnTitlebar Mouse5 :ShadeOn\n"; new_keyfile += "OnTitlebar Mouse4 :ShadeOff\n"; } else { new_keyfile += "OnTitlebar Mouse4 :ShadeOn\n"; new_keyfile += "OnTitlebar Mouse5 :ShadeOff\n"; } } else if (strcasecmp((*scroll_action).c_str(), "nexttab") == 0) { if (*rc_reverse) { new_keyfile += "OnTitlebar Mouse5 :PrevTab\n"; new_keyfile += "OnTitlebar Mouse4 :NextTab\n"; } else { new_keyfile += "OnTitlebar Mouse4 :PrevTab\n"; new_keyfile += "OnTitlebar Mouse5 :NextTab\n"; } } new_keyfile += "\n"; // just for good looks new_keyfile += whole_keyfile; // don't forget user's old keybindings write_file(keyfilename, new_keyfile); } void update_added_starttabbing_command(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); string new_keyfile = ""; // let's put our new keybindings first, so they're easy to find new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; new_keyfile += "OnTitlebar Mouse2 :StartTabbing\n\n"; new_keyfile += whole_keyfile; // don't forget user's old keybindings write_file(keyfilename, new_keyfile); } void update_disable_icons_in_tabs_for_backwards_compatibility(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { FbTk::Resource *show = new FbTk::Resource(rm, false, "session.screen0.tabs.usePixmap", "Session.Screen0.Tabs.UsePixmap"); if (!*show) // only change if the setting didn't already exist *show = false; } void update_change_format_of_split_placement_menu(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { FbTk::Resource *placement = new FbTk::Resource(rm, "BottomRight", "session.screen0.slit.placement", "Session.Screen0.Slit.Placement"); FbTk::Resource *direction = new FbTk::Resource(rm, "Vertical", "session.screen0.slit.direction", "Session.Screen0.Slit.Direction"); if (strcasecmp((**direction).c_str(), "vertical") == 0) { if (strcasecmp((**placement).c_str(), "BottomRight") == 0) *placement = "RightBottom"; else if (strcasecmp((**placement).c_str(), "BottomLeft") == 0) *placement = "LeftBottom"; else if (strcasecmp((**placement).c_str(), "TopRight") == 0) *placement = "RightTop"; else if (strcasecmp((**placement).c_str(), "TopLeft") == 0) *placement = "LeftTop"; } } void update_update_keys_file_for_nextwindow_syntax_changes(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); size_t pos = 0; while (true) { const char *keyfile = whole_keyfile.c_str(); const char *loc = 0; size_t old_pos = pos; // find the first position that matches any of next/prevwindow/group if ((loc = FbTk::StringUtil::strcasestr(keyfile + old_pos, "nextwindow"))) pos = (loc - keyfile) + 10; if ((loc = FbTk::StringUtil::strcasestr(keyfile + old_pos, "prevwindow"))) pos = (pos > old_pos && keyfile + pos < loc) ? pos : (loc - keyfile) + 10; if ((loc = FbTk::StringUtil::strcasestr(keyfile + old_pos, "nextgroup"))) pos = (pos > old_pos && keyfile + pos < loc) ? pos : (loc - keyfile) + 9; if ((loc = FbTk::StringUtil::strcasestr(keyfile + old_pos, "prevgroup"))) pos = (pos > old_pos && keyfile + pos < loc) ? pos : (loc - keyfile) + 9; if (pos == old_pos) break; pos = whole_keyfile.find_first_not_of(" \t", pos); if (pos != std::string::npos && isdigit(keyfile[pos])) { char *endptr = 0; unsigned int mask = strtoul(keyfile + pos, &endptr, 0); string insert = ""; if ((mask & 9) == 9) insert = "{static groups}"; else if (mask & 1) insert = "{groups}"; else if (mask & 8) insert = "{static}"; if (mask & 2) insert += " (stuck=no)"; if (mask & 4) insert += " (shaded=no)"; if (mask & 16) insert += " (minimized=no)"; if (mask) whole_keyfile.replace(pos, endptr - keyfile - pos, insert); } } write_file(keyfilename, whole_keyfile); } void update_keys_for_ongrip_onwindowborder(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_keyfile = read_file(keyfilename); string new_keyfile = ""; // let's put our new keybindings first, so they're easy to find new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; new_keyfile += "OnTitlebar Move1 :StartMoving\n"; new_keyfile += "OnLeftGrip Move1 :StartResizing bottomleft\n"; new_keyfile += "OnRightGrip Move1 :StartResizing bottomright\n"; new_keyfile += "OnWindowBorder Move1 :StartMoving\n\n"; new_keyfile += whole_keyfile; // don't forget user's old keybindings new_keyfile += "\n"; // just for good looks write_file(keyfilename, new_keyfile); } void update_keys_for_activetab(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_file = read_file(keyfilename); string new_keyfile = ""; new_keyfile += "!mouse actions added by fluxbox-update_configs\n"; new_keyfile += "OnTitlebar Mouse1 :MacroCmd {Focus} {Raise} {ActivateTab}\n"; new_keyfile += whole_file; new_keyfile += "\n"; // just for good looks write_file(keyfilename, new_keyfile); } // NextWindow {static groups} => NextWindow {static groups} (workspace=[current]) void update_limit_nextwindow_to_current_workspace(FbTk::ResourceManager& rm, const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) { string whole_file = read_file(keyfilename); string new_keyfile = ""; new_keyfile += "! fluxbox-update_configs added '(workspace=[current])' to (Next|Prev)(Window|Group)\n"; new_keyfile += "! check lines marked by 'FBCV13' if they are correctly updated\n"; const char* pos = whole_file.c_str(); string last_word; enum { SCAN, COMMENT, CMD, OPEN_STATIC_GROUP_OR_PATTERN, CLOSE_STATIC_GROUP }; int state = SCAN; bool mark_line_change = false; for ( ; *pos; ++pos) { new_keyfile += *pos; char c = tolower(*pos); switch (state) { case SCAN: if (c == '{' || c == ':') // ':NextWindow' or 'MacroCmd {NextWindow' state = CMD; break; case CMD: if (isspace(c) || c == '}' || c == '#' || c == '!' ) { if (last_word == "nextwindow" || last_word == "nextgroup" || last_word == "prevwindow" || last_word == "prevgroup") { // ':NewWindow[\n!#]' or 'MacroCmd {NextWindow}' if (c == '\n' || c == '#' || c == '!' || c == '}') { new_keyfile.insert(new_keyfile.size() - 1, " (workspace=[current])"); mark_line_change = true; state = SCAN; } else { state = OPEN_STATIC_GROUP_OR_PATTERN; } } else { state = SCAN; last_word.clear(); } } else { // possible '(next|prev)(group|window)' last_word += c; } break; case OPEN_STATIC_GROUP_OR_PATTERN: if (c == '{') { // NextWindow {static group} state = CLOSE_STATIC_GROUP; } else if (c == '(') { // NextWindow (foo=bar) new_keyfile += "workspace=[current]) ("; mark_line_change = true; state = SCAN; } else if (c == '}') { // MacroCmd {NextWindow } new_keyfile.insert(new_keyfile.size() - 1, " (workspace=[current]) "); mark_line_change = true; state = SCAN; } break; case CLOSE_STATIC_GROUP: if (c == '}') { new_keyfile += " (workspace=[current]) "; mark_line_change = true; state = SCAN; } break; }; if (*pos == '\n') { // a new line or a comment resets the state if (mark_line_change) new_keyfile.insert(new_keyfile.size() - 1, " !! FBCV13 !!"); mark_line_change = false; last_word.clear(); state = SCAN; } else if (*pos == '#' || *pos == '!') { last_word.clear(); state = COMMENT; } } new_keyfile += "\n"; // just for good looks write_file(keyfilename, new_keyfile); } /*------------------------------------------------------------------*\ \*------------------------------------------------------------------*/ struct Update { int version; void (*update)(FbTk::ResourceManager& rm, const FbTk::FbString&, const FbTk::FbString&); }; const Update UPDATES[] = { { 1, update_add_mouse_evens_to_keys }, { 2, update_move_groups_entries_to_apps_file }, { 3, update_move_toolbar_wheeling_to_keys_file }, { 4, update_move_modkey_to_keys_file }, { 5, update_window_patterns_for_iconbar }, { 6, update_move_titlebar_actions_to_keys_file }, { 7, update_added_starttabbing_command }, { 8, update_disable_icons_in_tabs_for_backwards_compatibility }, { 9, update_change_format_of_split_placement_menu }, { 10, update_update_keys_file_for_nextwindow_syntax_changes }, { 11, update_keys_for_ongrip_onwindowborder }, { 12, update_keys_for_activetab }, { 13, update_limit_nextwindow_to_current_workspace } }; /*------------------------------------------------------------------*\ \*------------------------------------------------------------------*/ int run_updates(int old_version, FbTk::ResourceManager &rm) { int new_version = old_version; FbTk::Resource rc_keyfile(rm, "~/.fluxbox/keys", "session.keyFile", "Session.KeyFile"); FbTk::Resource rc_appsfile(rm, "~/.fluxbox/apps", "session.appsFile", "Session.AppsFile"); string appsfilename = FbTk::StringUtil::expandFilename(*rc_appsfile); string keyfilename = FbTk::StringUtil::expandFilename(*rc_keyfile); for (size_t i = 0; i < sizeof(UPDATES) / sizeof(Update); ++i) { if (old_version < UPDATES[i].version) { UPDATES[i].update(rm, keyfilename, appsfilename); new_version = UPDATES[i].version; } } return new_version; } int main(int argc, char **argv) { string rc_filename; set style_filenames; int i = 1; bool check = 0; pid_t fb_pid = 0; FbTk::I18n::init(0); _FB_USES_NLS; for (; i < argc; i++) { string arg = argv[i]; if (arg == "-rc") { // look for alternative rc file to use if ((++i) >= argc) { cerr<<_FB_CONSOLETEXT(main, RCRequiresArg, "error: '-rc' requires an argument", "the -rc option requires a file argument")<= argc) { // need translations for this, too cerr<<"the -pid option requires a numeric argument"<\t\t\tuse alternate resource file.\n" << " -pid \t\t\ttell fluxbox to reload configuration.\n" << " -check\t\t\tcheck version of this tool and the fluxbox config.\n" << " -help\t\t\t\tdisplay this help text and exit.\n\n" << endl; exit(0); } } if (rc_filename.empty()) rc_filename = FbTk::StringUtil::expandFilename("~/.fluxbox/init"); FbTk::ResourceManager resource_manager(rc_filename.c_str(),false); if (!resource_manager.load(rc_filename.c_str())) { // couldn't load rc file cerr<<_FB_CONSOLETEXT(Fluxbox, CantLoadRCFile, "Failed to load database", "Failed trying to read rc file")<<":"< config_version(resource_manager, 0, "session.configVersion", "Session.ConfigVersion"); if (check) { cout << rc_filename << ": " << *config_version << endl << "fluxbox-update_configs: " << UPDATES[sizeof(UPDATES)/sizeof(Update) - 1].version << endl; exit(0); } int old_version = *config_version; int new_version = run_updates(old_version, resource_manager); if (new_version > old_version) { // configs were updated -- let's save our changes config_version = new_version; resource_manager.save(rc_filename.c_str(), rc_filename.c_str()); save_all_files(); #if defined(HAVE_SIGNAL_H) && !defined(_WIN32) // if we were given a fluxbox pid, send it a reconfigure signal if (fb_pid > 0) kill(fb_pid, SIGUSR2); #endif // defined(HAVE_SIGNAL_H) && !defined(_WIN32) } return 0; } namespace { set modified_files; // we may want to put a size limit on this cache, so it doesn't grow too big map file_cache; } // returns the contents of the file given, either from the cache or by reading // the file from disk string read_file(const string& filename) { // check if we already have the file in memory map::iterator it = file_cache.find(filename); if (it != file_cache.end()) return it->second; if (!FbTk::FileUtil::isRegularFile(filename.c_str())) { return ""; } // nope, we'll have to read the file ifstream infile(filename.c_str()); string whole_file = ""; if (!infile) // failed to open file return whole_file; string linebuffer; while (!infile.eof()) { getline(infile, linebuffer); whole_file += linebuffer + "\n"; } infile.close(); file_cache[filename] = whole_file; return whole_file; } #ifdef NOT_USED // remove the file from the cache, writing to disk if it's been changed void forget_file(const string& filename) { map::iterator cache_it = file_cache.find(filename); // check if we knew about the file to begin with if (cache_it == file_cache.end()) return; // check if we've actually modified it set::iterator mod_it = modified_files.find(filename); if (mod_it == modified_files.end()) { file_cache.erase(cache_it); return; } // flush our changes to disk and remove all traces ofstream outfile(filename.c_str()); outfile << cache_it->second; file_cache.erase(cache_it); modified_files.erase(mod_it); } #endif // NOT_USED // updates the file contents in the cache and marks the file as modified so it // gets saved later void write_file(const string& filename, const string &contents) { modified_files.insert(filename); file_cache[filename] = contents; } // actually save all the files we've modified void save_all_files() { set::iterator it = modified_files.begin(); set::iterator it_end = modified_files.end(); for (; it != it_end; ++it) { ofstream outfile(it->c_str()); outfile << file_cache[it->c_str()]; } modified_files.clear(); }