Skip to content
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.

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

Move OC host/port/protocol helpers to the bundle and deprecate them #15520

Merged
merged 1 commit into from
May 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/js/dist/login.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion core/js/dist/login.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion core/js/dist/main.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion core/js/dist/main.js.map

Large diffs are not rendered by default.

44 changes: 0 additions & 44 deletions core/js/js.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,50 +18,6 @@ Object.assign(window.OC, {
},

/**
* Protocol that is used to access this Nextcloud instance
* @return {string} Used protocol
*/
getProtocol: function() {
return window.location.protocol.split(':')[0];
},

/**
* Returns the host used to access this Nextcloud instance
* Host is sometimes the same as the hostname but now always.
*
* Examples:
* http://example.com => example.com
* https://example.com => example.com
* http://example.com:8080 => example.com:8080
*
* @return {string} host
*
* @since 8.2
*/
getHost: function() {
return window.location.host;
},

/**
* Returns the hostname used to access this Nextcloud instance
* The hostname is always stripped of the port
*
* @return {string} hostname
* @since 9.0
*/
getHostName: function() {
return window.location.hostname;
},

/**
* Returns the port number used to access this Nextcloud instance
*
* @return {int} port number
*
* @since 8.2
*/
getPort: function() {
return window.location.port;
},

/**
Expand Down
63 changes: 63 additions & 0 deletions core/src/OC/host.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* Protocol that is used to access this Nextcloud instance
* @return {string} Used protocol
* @deprecated 17.0.0 use window.location.protocol directly
*/
export const getProtocol = () => window.location.protocol.split(':')[0]

/**
* Returns the host used to access this Nextcloud instance
* Host is sometimes the same as the hostname but now always.
*
* Examples:
* http://example.com => example.com
* https://example.com => example.com
* http://example.com:8080 => example.com:8080
*
* @return {string} host
*
* @since 8.2
* @deprecated 17.0.0 use window.location.host directly
*/
export const getHost = () => window.location.host

/**
* Returns the hostname used to access this Nextcloud instance
* The hostname is always stripped of the port
*
* @return {string} hostname
* @since 9.0
* @deprecated 17.0.0 use window.location.hostname directly
*/
export const getHostName = () => window.location.hostname

/**
* Returns the port number used to access this Nextcloud instance
*
* @return {int} port number
*
* @since 8.2
* @deprecated 17.0.0 use window.location.port directly
*/
export const getPort = () => window.location.port
14 changes: 14 additions & 0 deletions core/src/OC/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ import Dialogs from './dialogs'
import EventSource from './eventsource'
import {get, set} from './get_set'
import {getCapabilities} from './capabilities'
import {
getHost,
getHostName,
getPort,
getProtocol,
} from './host'
import {
getToken as getRequestToken,
subscribe as subscribeToRequestTokenChange,
Expand Down Expand Up @@ -157,6 +163,14 @@ export default {
isSamePath,
joinPaths,

/**
* Host (url) helpers
*/
getHost,
getHostName,
getPort,
getProtocol,

/**
* L10n
*/
Expand Down