Checks if the configuration file exists #2026

nekiter · 2020-03-01T14:07:42Z

Description

Today when polybar start it does the following configuration search:

-c/--config parameter
$XDG_CONFIG_HOME/polybar/config , if the variable is set
$HOME/polybar/config , if the variable is set
Throw error

But it doesn't check if the file exists, this pull request solves that, so the new configuration search is:

-c/--config parameter (if specified)
$XDG_CONFIG_HOME/polybar/config , if the file exists (variable still being checked)
$HOME/.config/polybar/config , if the file exists (variable still being checked)
Throw error

Solves

This PR closes the issue 2016, this issue also ask for a change that makes a lot of sense but it'd be another PR:

move the example of config file from .../doc/polybar/config to .../doc/polybar/examples/config , that change need an update on wiki.

codecov · 2020-03-01T14:12:57Z

Codecov Report

Merging #2026 into master will decrease coverage by 0.04%.
The diff coverage is 0%.

@@            Coverage Diff            @@
##           master   #2026      +/-   ##
=========================================
- Coverage     9.3%   9.26%   -0.05%     
=========================================
  Files         180     180              
  Lines       10823   10849      +26     
=========================================
- Hits         1007    1005       -2     
- Misses       9816    9844      +28

Flag	Coverage Δ
#unittests	`9.26% <0%> (-0.05%)`	⬇️

Impacted Files	Coverage Δ
include/utils/file.hpp	`75% <ø> (ø)`	⬆️
src/utils/file.cpp	`31.03% <0%> (-2.55%)`	⬇️
include/errors.hpp	`0% <0%> (-40%)`	⬇️
include/utils/math.hpp	`79.41% <0%> (-4.97%)`	⬇️
include/modules/meta/inotify_module.hpp	`0% <0%> (ø)`	⬆️
include/events/signal.hpp	`0% <0%> (ø)`	⬆️
include/adapters/net.hpp	`0% <0%> (ø)`	⬆️
include/components/types.hpp	`0% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f02fb67...499f237. Read the comment docs.

patrick96

Good job! I think separating this logic into a function could make it look a lot cleaner :)

Thanks for contributing!

patrick96 · 2020-03-01T15:38:10Z

src/main.cpp

+    if (env_util::has("XDG_CONFIG_HOME") && confpath.empty()) {
      confpath = env_util::get("XDG_CONFIG_HOME") + "/polybar/config";
-    } else if (env_util::has("HOME")) {
+      if (!file_util::exists(confpath)) {
+        confpath = "";
+      }
+    }
+    if (env_util::has("HOME") && confpath.empty()) {
      confpath = env_util::get("HOME") + "/.config/polybar/config";
-    } else {
+      if (!file_util::exists(confpath)) {
+        confpath = "";
+      }
+    }


I would suggest putting this part into a separate function here in main.cpp. This way you don't have to use the workaround of setting confpath to the empty string everytime and can just return early.

I've made this change, but I'm not sure if the place that I putted the function is appropriated, I was thinking about put it on config class, but it would force polybar instantiate the config class earlier making this small change affect more the code. What do u think?

I think it would also have been fine in main.cpp, but this is also good.

patrick96

Looks good. Thanks a lot! 🚀

This should reflect the changes from polybar#2026

This should reflect the changes from #2026

Breaking Changes: * The new config parser imposes some restrictions on which characters can be used in section and key names. Users shouldn't be affected by this unless they use one of the following characters in any section or key name: `"'=;#[](){}:.$\%` Please consult [`man 5 polybar`](https://polybar.readthedocs.io/en/latest/man/polybar.5.html) for a full reference of the new config rules. * `internal/temperature`: The first and last ramp element are now only used for `base-temperature` and below and `warn-temperature` and above respectively. This only slightly changes the ranges for which the different ramp levels are responsible for. (#2197) Changelog **Deprecations** * `[settings]`: `throttle-input-for` has been removed. It wasn't a useful option and could cause certain actions (e.g. click commands) to be ignored. (#2117) * All action names used by modules to handle click and scroll events are depercated (#1907). This change mainly affects users of the menu module. Please read the [documentation](https://polybar.readthedocs.io/en/latest/user/actions.html) for instructions on how to migrate. **New Config Options** The `include-directory` key can be used the same as `include-file` and includes all regular files in the given directory. In labels: * `label-NAME-minlen`, `label-NAME-alignment` can be used to pad labels with spaces to the right (alignment set to `left`), left (alignment set to `right`), and both sides (alignment set to `center`). In `internal/backlight`: * `enable-scroll` enables changing the brightness through scrolling. In `internal/github`: * `format-offline` is used when the module cannot connect to the server. * `label-offline` can be used in `format-offline`. * `api-url` can be used to connect to a custom github enterprise instance In `internal/pulseaudio`: * `click-right` and `click-middle` can be used to execute commands when right/middle clicking. * `%decibels%` token can be used in `label-volume` and `label-muted` to show the volume in decibels. **Changes To The Build System** * Allow users to specify python executable when building. (polybar/xpp#27, #2125) * The i3ipcpp submodule no longer rebuilds jsoncpp and just uses whatever version is available. (#2015, polybar/i3ipcpp#9) **Features** * New commandline argument: `-M` / `--list-all-monitors`. Will display all available monitors (even cloned ones). * New log level: `notice`. Used as the default and is used for non-warning messages the user should nevertheless be aware of. (#2027) * config: * New config parser (#1377) * `include-directory` key (#2196), see #1946 * Add error message when an entire section is missing. (#2195) * `-minlen` and `-alignment` properties for labels. (#1546) * Make the `seperator` key in the bar section a label. (#1918) * Better color validation. (#1290) * timer modules: Schedule module updates to be aligned with the update interval. For example, the date module now updates on the minute instead of in the middle of a minute if the interval is set to 60 seconds. (#2123), see #2064 * `custom/menu`: Multiple menu modules per bar (#1907) * `internal/backlight`: Support for changing the brightness through scrolling. This may require additional changes to the system running polybar. (#1957) * `internal/github`: * `format-offline` for when the module cannot connect to the server (#1825), see #1815 * Support for github enterprise instances. (#1841), see #1812 * `internal/network`: Support `Gbit/s` for `%linkspeed%` token. (#2055) * `internal/pulseaudio`: * `click-right` and `click-middle` keys (#1941) * `%decibels%` token (#1894), see #1886 * `internal/xworkspaces`: Proper implementation for `label-occupied`. (#822), see #874, #1444, #1033 **Fixes** * Polybar not executing commands that produce output. (#1680), see #916 * Polybar froze until click commands finished executing (#2248) * Polybar not properly working with mirrored monitors. (#1823), see #1192 and #1794 * Unstable animation framerate (#1683), see #568 * Multiple modules of the same type caused click events not to be delivered to the rigth one (#1907), see #1172 * config: * Seemingly unrelated error messages when BOM character appears in config. (#2166), see #2075 * Fall back to next possible config location if config file doesn't exist (except if `--config` was used). (#2026), see #2016 * iconset: `fuzzy-match` chose first match, even if exact match was available. (#2042), see #2041 * `custom/menu`: Spacing issue (#1656) * `internal/alsa`: Volume didn't go over 100% (#2184), see #2173 * `internal/backlight`: Use amdgpu workaround for all devices starting with `amdgpu_bl`. (#2122) * `internal/battery`: Battery not marked as full if over `full-at` percent. (#2019), see #1622 * `internal/cpu`: More accurate cpu load calculation. (#1955) * `internal/github`: Outdated GitHub API authentication. (#2029), see #2002 * `internal/memory`: Use the correct size prefixes (#2211), see #2023 * `internal/network`: * Wrong up- and downspeed values for non-integer intervals. (#2219) * tun/tap interfaces didn't query their IP addresses. (#1990), see #1986 * Don't crash module if linkspeed cannot be queried. (#1772), see #1211 * `internal/temperature`: * `format-warn` was not used if the temperature was *exactly* `warn-temperature`. (#1897) * `internal/xworkspaces`: * Multi-monitor issue (#1929), see #1764, #1849 * Module sometimes showed too many workspaces (#1984), see #1983 * build: * xpp submodule doesn't work with python 3.9 (polybar/xpp#26) * CMake 3.17+ developer warnings (#2089, polybar/xpp#24, polybar/xpp#25) * gtest compilation failure (#1993), see google/googletest#2678 * Compilation issue in GCC 6. (#1953)

Breaking Changes: * The new config parser imposes some restrictions on which characters can be used in section and key names. Users shouldn't be affected by, this unless they use one of the following characters in any section or key name: `"'=;#[](){}:.$\%` Please consult [`man 5 polybar`](https://polybar.readthedocs.io/en/latest/man/polybar.5.html) for a full reference of the new config rules. * `internal/temperature`: The first and last ramp element are now only used for `base-temperature` and below and `warn-temperature` and above respectively. This only slightly changes the ranges for which the different ramp levels are responsible for. (#2197) Changelog **Deprecations** * `[settings]`: `throttle-input-for` has been removed. It wasn't a useful option and could cause certain actions (e.g. click commands) to be ignored. (#2117) * All action names used by modules to handle click and scroll events are deprecated (#1907). This change mainly affects users of the menu module. Please read the [documentation](https://polybar.readthedocs.io/en/latest/user/actions.html) for instructions on how to migrate. **New Config Options** The `include-directory` key can be used the same as `include-file` and includes all regular files in the given directory. In labels: * `label-NAME-minlen`, `label-NAME-alignment` can be used to pad labels with spaces to the right (alignment set to `left`), left (alignment set to `right`), and both sides (alignment set to `center`). In `internal/backlight`: * `enable-scroll` enables changing the brightness through scrolling. In `internal/github`: * `format-offline` is used when the module cannot connect to the server. * `label-offline` can be used in `format-offline`. * `api-url` can be used to connect to a custom github enterprise instance In `internal/pulseaudio`: * `click-right` and `click-middle` can be used to execute commands when right/middle clicking. * `%decibels%` token can be used in `label-volume` and `label-muted` to show the volume in decibels. **Changes To The Build System** * Allow users to specify python executable when building. (polybar/xpp#27, #2125) * The i3ipcpp submodule no longer rebuilds jsoncpp and just uses whatever version is available. (#2015, polybar/i3ipcpp#9) **Features** * New commandline argument: `-M` / `--list-all-monitors`. Will display all available monitors (even cloned ones). * New log level: `notice`. Used as the default and is used for non-warning messages the user should nevertheless be aware of. (#2027) * config: * New config parser (#1377) * `include-directory` key (#2196), see #1946 * Add error message when an entire section is missing. (#2195) * `-minlen` and `-alignment` properties for labels. (#1546) * Make the `seperator` key in the bar section a label. (#1918) * Better color validation. (#1290) * timer modules: Schedule module updates to be aligned with the update interval. For example, the date module now updates on the minute instead of in the middle of a minute if the interval is set to 60 seconds. (#2123), see #2064 * `custom/menu`: Multiple menu modules per bar (#1907) * `internal/backlight`: Support for changing the brightness through scrolling. This may require additional changes to the system running polybar. (#1957) * `internal/github`: * `format-offline` for when the module cannot connect to the server (#1825), see #1815 * Support for github enterprise instances. (#1841), see #1812 * `internal/network`: Support `Gbit/s` for `%linkspeed%` token. (#2055) * `internal/pulseaudio`: * `click-right` and `click-middle` keys (#1941) * `%decibels%` token (#1894), see #1886 * `internal/xworkspaces`: Proper implementation for `label-occupied`. (#822), see #874, #1444, #1033 **Fixes** * Polybar not executing commands that produce output. (#1680), see #916 * Polybar froze until click commands finished executing (#2248) * Polybar not properly working with mirrored monitors. (#1823), see #1192 and #1794 * Unstable animation framerate (#1683), see #568 * Multiple modules of the same type caused click events not to be delivered to the rigth one (#1907), see #1172 * config: * Seemingly unrelated error messages when BOM character appears in config. (#2166), see #2075 * Fall back to next possible config location if config file doesn't exist (except if `--config` was used). (#2026), see #2016 * iconset: `fuzzy-match` chose first match, even if exact match was available. (#2042), see #2041 * `custom/menu`: Spacing issue (#1656) * `internal/alsa`: Volume didn't go over 100% (#2184), see #2173 * `internal/backlight`: Use amdgpu workaround for all devices starting with `amdgpu_bl`. (#2122) * `internal/battery`: Battery not marked as full if over `full-at` percent. (#2019), see #1622 * `internal/cpu`: More accurate cpu load calculation. (#1955) * `internal/github`: Outdated GitHub API authentication. (#2029), see #2002 * `internal/memory`: Use the correct size prefixes (#2211), see #2023 * `internal/network`: * Wrong up- and downspeed values for non-integer intervals. (#2219) * tun/tap interfaces didn't query their IP addresses. (#1990), see #1986 * Don't crash module if linkspeed cannot be queried. (#1772), see #1211 * `internal/temperature`: * `format-warn` was not used if the temperature was *exactly* `warn-temperature`. (#1897) * `internal/xworkspaces`: * Multi-monitor issue (#1929), see #1764, #1849 * Module sometimes showed too many workspaces (#1984), see #1983 * build: * xpp submodule doesn't work with python 3.9 (polybar/xpp#26) * CMake 3.17+ developer warnings (#2089, polybar/xpp#24, polybar/xpp#25) * gtest compilation failure (#1993), see google/googletest#2678 * Compilation issue in GCC 6. (#1953)

update: Checks if the configuration file exists

7293dea

patrick96 requested changes Mar 1, 2020

View reviewed changes

Update: Removing the logic of the config file search from main.cpp

499f237

patrick96 approved these changes Mar 1, 2020

View reviewed changes

patrick96 merged commit 512c519 into polybar:master Mar 1, 2020

patrick96 added a commit to patrick96/polybar that referenced this pull request Nov 23, 2020

doc: Reflect config fallback in config

a485082

This should reflect the changes from polybar#2026

patrick96 mentioned this pull request Nov 23, 2020

doc: Reflect config fallback in config #2245

Merged

patrick96 added a commit that referenced this pull request Nov 23, 2020

doc: Reflect config fallback in config

c34f013

This should reflect the changes from #2026

patrick96 mentioned this pull request Nov 29, 2020

Release 3.5.0 #2253

Merged

28 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Checks if the configuration file exists #2026

Checks if the configuration file exists #2026

Uh oh!

nekiter commented Mar 1, 2020

Uh oh!

codecov bot commented Mar 1, 2020 •

edited

Loading

Uh oh!

patrick96 left a comment

Uh oh!

patrick96 Mar 1, 2020

Uh oh!

nekiter Mar 1, 2020

Uh oh!

patrick96 Mar 1, 2020

Uh oh!

patrick96 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Checks if the configuration file exists #2026

Checks if the configuration file exists #2026

Uh oh!

Conversation

nekiter commented Mar 1, 2020

Uh oh!

codecov bot commented Mar 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

patrick96 Mar 1, 2020

Choose a reason for hiding this comment

Uh oh!

nekiter Mar 1, 2020

Choose a reason for hiding this comment

Uh oh!

patrick96 Mar 1, 2020

Choose a reason for hiding this comment

Uh oh!

patrick96 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Mar 1, 2020 •

edited

Loading