Class: User
- Inherits:
-
ApplicationRecord
- Object
- ActiveRecord::Base
- ApplicationRecord
- User
- Includes:
- Housekeeping::Timestamps, Housekeeping::Users, Shared::DataAttributes, Shared::Identifiers, Shared::Notes, Shared::Tags, Preferences
- Defined in:
- app/models/user.rb,
app/models/user/preferences.rb
Overview
A User is a TaxonWorks user, at present someone who can logon to the private workebench.
All Data Models contain created_by_id and updated_by_id that references a User.
A user may have a number of attributes that define roles/subclasses of a sort:
1) Administrators (User#is_administrator = true). An administrator can do absolutely everything, in any project, and across any project, except set User#is_administrator = false. It is intended that there be only 1-2 administrators per instance of TaxonWorks.
2) Project Administrators (ProjectMember#is_project_administrator). A project administrator can set Project settings and preferences, including the views that a Worker can see.
3) Superuser. A super_user (code only) is a User that is a profromct administrator OR administrator.
4) Worker. A worker is a User that can only see parts of the workbench allowed by a ProjectAdministrator.
Data models in TaxonWorks reference People, who may have roles as Sources (or others), i.e. Users are not “data” and not linked directly to People records.
Users must never be shared by real-life humans.
Defined Under Namespace
Modules: Preferences
Constant Summary collapse
- VALID_EMAIL_REGEX =
/\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
- HUB_FAVORITES =
{'data' => [], 'tasks' => []}.freeze
Constants included from Preferences
Instance Attribute Summary collapse
-
#api_access_token ⇒ String
Authentication token used to authenticate against /api endpoints.
-
#current_sign_in_at ⇒ ActiveSupport::TimeWithZone
Time of current sign in.
-
#current_sign_in_ip ⇒ String
IP address of the machine user is currently logged in from.
-
#email ⇒ String
The users email, and login.
-
#footprints ⇒ Hash
Tracks the users recent requests.
- #hub_favorites ⇒ Hash
-
#hub_tab_order ⇒ Array
Tabs, referenced as Strings, defining the users preference for their order.
-
#is_administrator ⇒ Boolean
True if user is an administrator, administrators can do everything in any project taxonworks.
-
#is_flagged_for_password_reset ⇒ Boolean
When true user must reset their password before doing anything further.
-
#last_sign_in_at ⇒ ActiveSupport::TimeWithZone
Time of sign in prior to this sign in.
-
#last_sign_in_ip ⇒ String
IP address of the machine user used to log in from prior to this current log in.
-
#name ⇒ String
a users name: Not intended to be a nickname, but this is loosely enforced.
-
#password_digest ⇒ String
The users password.
-
#password_reset_token ⇒ String
If user has requested a password reset the token is stored here.
-
#password_reset_token_date ⇒ DateTime
Helps determine how long the password reset token is valid.
- #remember_token ⇒ String
-
#self_created ⇒ true, false
Only used for when .new_record? is true.
-
#set_new_api_access_token ⇒ Object
Returns the value of attribute set_new_api_access_token.
-
#sign_in_count ⇒ Integer
A count of the number of times a user has logged in.
-
#time_active ⇒ Integer?
Estimated time in seconds.
Attributes included from Housekeeping::Users
Class Method Summary collapse
- .batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) ⇒ Object
- .encrypt(token) ⇒ String
-
.get_user_ids(*users) ⇒ Array of Integers
TODO: deprecate for a User filter query.
-
.in_project(project_id = Current.project_id) ⇒ Scope
Of ids for users in the project.
-
.not_in_project(project_id) ⇒ Scope
Of users.
-
.secure_random_token ⇒ String
Of token.
Instance Method Summary collapse
-
#add_page_to_favorites(options = {}) ⇒ Boolean
rubocop:disable Style/StringHashKeys.
-
#add_recently_visited_to_footprint(recent_route, recent_object = nil) ⇒ Boolean
TODO: move to User concern.
-
#administered_projects ⇒ Scope
Of projects.
- #administers_projects? ⇒ Boolean
- #configure_self_created ⇒ Object private
- #creates_data_of_type?(klass) ⇒ Boolean
- #curates_data? ⇒ Boolean
-
#data_in_projects ⇒ Object
Array of Projects A quick, not comprehensive check of what projects User has touched data in.
- #data_types_added ⇒ Array
- #generate_api_access_token ⇒ String
-
#get_class_created_updated ⇒ Hash
rubocop:disable Metrics/MethodLength.
-
#is_administrator? ⇒ Boolean
True if is_administrator = true.
-
#is_project_administrator?(project = nil) ⇒ Boolean
True if user is_project_administrator for the project passed.
-
#is_superuser?(project = nil) ⇒ Boolean
True if user is_administrator or is_project_administrator.
- #member_of?(project) ⇒ Boolean
- #orcid ⇒ Object
-
#pinboard_hash(project_id) ⇒ Scope
TODO: This needs to show cross-project pinboard items as well.
-
#preferences(value) ⇒ true, false
Only used for when .new_record? is true.
-
#remove_page_from_favorites(options = {}) ⇒ Object
TODO: move to User concern.
-
#require_password_presence ⇒ Boolean
Always true.
- #set_remember_token ⇒ String private
-
#total_objects(klass) ⇒ Integer
The total records of this klass created by this user.
- #total_objects2(klass_string) ⇒ Integer
- #transfer_housekeeping(target_user) ⇒ Object
- #transfer_projects_membership(target_user) ⇒ Object
-
#update_last_seen_at ⇒ Boolean
TODO: move to User concern.
-
#update_project_member_last_seen_at ⇒ Object
TODO: we still global track at User, this is hit only when that ticker ticks perhaps seperate for performace.
-
#validate_favorite_options(options) ⇒ Boolean
TODO: move to User concern.
- #validate_password? ⇒ Boolean private
- #wikidata_id ⇒ Object
Methods included from Housekeeping::Users
#set_created_by_id, #set_updated_by_id
Methods included from Shared::Tags
#reject_tags, #tag_with, #tagged?, #tagged_with?
Methods included from Shared::Notes
#concatenated_notes_string, #reject_notes
Methods included from Shared::DataAttributes
#import_attributes, #internal_attributes, #keyword_value_hash, #reject_data_attributes
Methods included from Preferences
#fill_preferences, #layout=, #reset_hub_favorites, #reset_preferences
Methods included from Shared::Identifiers
#dwc_occurrence_id, #identified?, #next_by_identifier, #previous_by_identifier, #reject_identifiers, #uri, #uuid
Methods inherited from ApplicationRecord
Instance Attribute Details
#api_access_token ⇒ String
Returns authentication token used to authenticate against /api endpoints.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#current_sign_in_at ⇒ ActiveSupport::TimeWithZone
Returns time of current sign in.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#current_sign_in_ip ⇒ String
Returns IP address of the machine user is currently logged in from.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#email ⇒ String
Returns the users email, and login.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#footprints ⇒ Hash
Returns tracks the users recent requests.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#hub_favorites ⇒ Hash
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#hub_tab_order ⇒ Array
Returns tabs, referenced as Strings, defining the users preference for their order.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#is_administrator ⇒ Boolean
Returns true if user is an administrator, administrators can do everything in any project taxonworks.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#is_flagged_for_password_reset ⇒ Boolean
Returns when true user must reset their password before doing anything further.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#last_sign_in_at ⇒ ActiveSupport::TimeWithZone
Returns time of sign in prior to this sign in.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#last_sign_in_ip ⇒ String
Returns IP address of the machine user used to log in from prior to this current log in.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#name ⇒ String
a users name: Not intended to be a nickname, but this is loosely enforced. Attribute is intended to identify a human who owns this account.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#password_digest ⇒ String
Returns the users password.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#password_reset_token ⇒ String
Returns if user has requested a password reset the token is stored here.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#password_reset_token_date ⇒ DateTime
Returns helps determine how long the password reset token is valid.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#remember_token ⇒ String
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#self_created ⇒ true, false
Only used for when .new_record? is true. If true assigns creator and updater as self.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#set_new_api_access_token ⇒ Object
Returns the value of attribute set_new_api_access_token.
127 128 129 |
# File 'app/models/user.rb', line 127 def set_new_api_access_token @set_new_api_access_token end |
#sign_in_count ⇒ Integer
Returns a count of the number of times a user has logged in.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#time_active ⇒ Integer?
Returns estimated time in seconds.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
Class Method Details
.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) ⇒ Object
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'app/models/user.rb', line 194 def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end |
.encrypt(token) ⇒ String
269 270 271 |
# File 'app/models/user.rb', line 269 def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end |
.get_user_ids(*users) ⇒ Array of Integers
TODO: deprecate for a User filter query
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'app/models/user.rb', line 224 def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end |
.in_project(project_id = Current.project_id) ⇒ Scope
Returns of ids for users in the project.
258 259 260 |
# File 'app/models/user.rb', line 258 def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end |
.not_in_project(project_id) ⇒ Scope
Returns of users.
249 250 251 252 253 254 |
# File 'app/models/user.rb', line 249 def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end |
.secure_random_token ⇒ String
Returns of token.
263 264 265 |
# File 'app/models/user.rb', line 263 def User.secure_random_token SecureRandom.urlsafe_base64 end |
Instance Method Details
#add_page_to_favorites(options = {}) ⇒ Boolean
rubocop:disable Style/StringHashKeys
305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'app/models/user.rb', line 305 def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end |
#add_recently_visited_to_footprint(recent_route, recent_object = nil) ⇒ Boolean
TODO: move to User concern
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'app/models/user.rb', line 382 def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end |
#administered_projects ⇒ Scope
Returns of projects.
163 164 165 |
# File 'app/models/user.rb', line 163 def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end |
#administers_projects? ⇒ Boolean
168 169 170 |
# File 'app/models/user.rb', line 168 def administers_projects? administered_projects.any? end |
#configure_self_created ⇒ Object (private)
541 542 543 544 545 |
# File 'app/models/user.rb', line 541 def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end |
#creates_data_of_type?(klass) ⇒ Boolean
189 190 191 |
# File 'app/models/user.rb', line 189 def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end |
#curates_data? ⇒ Boolean
173 174 175 176 177 178 |
# File 'app/models/user.rb', line 173 def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end |
#data_in_projects ⇒ Object
Returns Array of Projects A quick, not comprehensive check of what projects User has touched data in.
495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'app/models/user.rb', line 495 def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end |
#data_types_added ⇒ Array
181 182 183 184 185 186 187 |
# File 'app/models/user.rb', line 181 def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end |
#generate_api_access_token ⇒ String
474 475 476 |
# File 'app/models/user.rb', line 474 def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end |
#get_class_created_updated ⇒ Hash
rubocop:disable Metrics/MethodLength
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'app/models/user.rb', line 435 def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end |
#is_administrator? ⇒ Boolean
Returns true if is_administrator = true.
280 281 282 |
# File 'app/models/user.rb', line 280 def is_administrator? is_administrator.blank? ? false : true end |
#is_project_administrator?(project = nil) ⇒ Boolean
Returns true if user is_project_administrator for the project passed.
286 287 288 289 |
# File 'app/models/user.rb', line 286 def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end |
#is_superuser?(project = nil) ⇒ Boolean
Returns true if user is_administrator or is_project_administrator.
275 276 277 |
# File 'app/models/user.rb', line 275 def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end |
#member_of?(project) ⇒ Boolean
293 294 295 |
# File 'app/models/user.rb', line 293 def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end |
#orcid ⇒ Object
483 484 485 486 |
# File 'app/models/user.rb', line 483 def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end |
#pinboard_hash(project_id) ⇒ Scope
TODO: This needs to show cross-project pinboard items as well
410 411 412 413 414 415 416 417 418 |
# File 'app/models/user.rb', line 410 def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end |
#preferences=(value) ⇒ true, false
Only used for when .new_record? is true. If true assigns creator and updater as self.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'app/models/user.rb', line 106 class User < ApplicationRecord include Shared::Identifiers # TODO: this is required before Housekeeping::Users, resolve include User::Preferences include Shared::DataAttributes include Shared::Notes include Shared::Tags include Housekeeping::Users include Housekeeping::Timestamps include Shared::RandomTokenFields[:password_reset] has_secure_password VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i HUB_FAVORITES = {'data' => [], 'tasks' => []}.freeze store :preferences, accessors: [:disable_chime], coder: JSON attr_accessor :set_new_api_access_token attr_accessor :self_created belongs_to :person, inverse_of: :user before_validation { self.email = email.to_s.downcase } before_save :generate_api_access_token, if: :set_new_api_access_token # @todo downcase does not work for non-ascii characters which means our validation for uniqueness will fail ... why? # @see http://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-email-address # @see http://unicode-utils.rubyforge.org/ before_save { self.email = email.to_s.downcase } after_save :configure_self_created, if: :self_created before_create :set_remember_token before_create { self.hub_tab_order = DEFAULT_HUB_TAB_ORDER } validates :email, presence: true, format: {with: VALID_EMAIL_REGEX}, uniqueness: true validates :password, length: {minimum: 8, if: :validate_password?}, confirmation: {if: :validate_password?} validates :name, presence: true validates :name, length: {minimum: 2}, unless: -> { self.name.blank? } has_many :project_members, dependent: :destroy has_many :projects, through: :project_members has_many :pinboard_items, dependent: :destroy scope :is_administrator, -> { where(is_administrator: true) } # @return [Scope] of projects def administered_projects projects.where(id: project_members.where(is_project_administrator: true).pluck(:project_id)) end # @return [Boolean] def administers_projects? administered_projects.any? end # @return [Boolean] def curates_data? Project::MANIFEST.each do |m| return true if creates_data_of_type?(m.safe_constantize) end false end # @return [Array] def data_types_added types = [] Project::MANIFEST.each do |m| types.push(m) if creates_data_of_type?(m.safe_constantize) end types end def creates_data_of_type?(klass) klass.column_names.include?('created_by_id') && (klass.where(created_by_id: id).or(klass.where(updated_by_id: id))).any? end # @return def self.batch_create(users: '', create_api_token: false, is_administrator: false, project_id: nil, created_by: nil) return [] if users.blank? || created_by.nil? v = [] users.split("\n").each do |r| next if r.blank? email, name = r.split(',') p = SecureRandom.hex u = User.create( email:, name:, set_new_api_access_token: create_api_token, is_administrator:, by: created_by, password: p, password_confirmation: p, is_flagged_for_password_reset: true ) v.push u if project_id.present? && u.valid? ProjectMember.create(user: u, project_id:) end end v end # TODO: deprecate for a User filter query # @param [String, User, Integer, Array] users # @return [Array of Integers] selected user ids def self.get_user_ids(*users) user_ids = [] users.flatten.each { |user| case user.class.name when 'String' # search by name or email ut = User.arel_table c1 = ut[:name].eq(user) .or(ut[:name].matches("%#{user}")) .or(ut[:name].matches("%#{user}%")) .or(ut[:email].eq(user)) .or(ut[:email].matches("%#{user}")) .or(ut[:email].matches("%#{user}%")).to_sql user_ids.push(User.where(c1).pluck(:id)) when 'User' user_ids.push(user.id) when 'Integer' user_ids.push(user) end } user_ids.flatten.uniq end # @param [Integer] project_id # @return [Scope] of users def self.not_in_project(project_id) ids = ProjectMember.where(project_id:).pluck(:user_id) return where(false) if ids.empty? User.where(User.arel_table[:id].not_eq_all(ids)) end # @param [Integer] project_id # @return [Scope] of ids for users in the project def self.in_project(project_id = Current.project_id ) ProjectMember.where(project_id:).distinct.pluck(:user_id) end # @return [String] of token def User.secure_random_token SecureRandom.urlsafe_base64 end # @param [String] token # @return [String] def User.encrypt(token) Digest::SHA1.hexdigest(token.to_s) end # @param [Project] project # @return [Boolean] true if user is_administrator or is_project_administrator def is_superuser?(project = nil) is_administrator || is_project_administrator?(project) end # @return [Boolean] true if is_administrator = true def is_administrator? is_administrator.blank? ? false : true end # @param [Project] project # @return [Boolean] true if user is_project_administrator for the project passed def is_project_administrator?(project = nil) return false if project.nil? project.project_members.where(user_id: id).first.is_project_administrator end # @param [Project, Integer] # @return [Boolean] def member_of?(project) ProjectMember.where(project_id: project, user_id: self.id).any? end # @return [Hash] def hub_favorites read_attribute(:hub_favorites) || {} end # rubocop:disable Style/StringHashKeys # @param [Hash] options # @return [Boolean] always true def add_page_to_favorites( = {}) # name: nil, kind: nil, project_id: nil () n = [:name] p = [:project_id].to_s k = [:kind] u = hub_favorites.dup u[p] = HUB_FAVORITES.dup if !u[p] u[p][k] = u[p][k].push(n).uniq[0..39].sort update_column(:hub_favorites, u) true end # rubocop:enable Style/StringHashKeys # TODO: move to User concern # @param [Hash] options def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end # TODO: move to User concern # @param [Hash] options # @return [Boolean] def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end # TODO: move to User concern # @return [Boolean] # If user has been active within the last 5 minutes, and at least 5 # seconds past their last activity, update their time_active. # The latter prevents multiple writes on many async calls. # def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end # TODO: we still global track at User, this is hit only when that # ticker ticks # perhaps seperate for performace def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end # TODO: move to User concern # @param [String] recent_route # @param [Object] recent_object # @return [Boolean] always true def add_recently_visited_to_footprint(recent_route, recent_object = nil) case recent_route when /\A\/\Z/ # the root path '/' when /\A\/hub/ # any path which starts with '/hub' when /\/autocomplete\?/ # any path used for AJAX autocomplete else fp = footprints.dup fp['recently_visited'] ||= [] attrs = {recent_route => {}} if !recent_object.nil? attrs[recent_route].merge!(object_type: recent_object.class.to_s, object_id: recent_object.id) end fp['recently_visited'].unshift(attrs) fp['recently_visited'] = fp['recently_visited'].uniq { |a| a.keys }[0..19] self.footprints_will_change! # if this isn't thrown weird caching happens ! self.update_column(:footprints, fp) end true end # TODO: This needs to show cross-project pinboard items as well # @param [Integer] project_id # @return [Scope] of pinboard items def pinboard_hash(project_id) h = {} pinboard_items.where(project_id:).order('pinned_object_type DESC, position').each do |i| l = i.pinned_object_type == 'ControlledVocabularyTerm' ? i.pinned_object.class.name : i.pinned_object_type h[l] ||= [] h[l].push i end h end # @param [String] klass # @return [Integer] the total records of this klass created by this user def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end # @param [String] klass_string # @return [Integer] def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end # rubocop:disable Metrics/MethodLength # @return [Hash] # @user.get_class_created_updated # => { "projects" => {created: 10, first_created: datetime, updated: 10, last_updated: datetime} } def get_class_created_updated # Rails.application.eager_load! if Rails.env.development? data = {} User.reflect_on_all_associations(:has_many).each do |r| key = nil # puts r.name.to_s if r.name.to_s =~ /created_/ # puts "after created" key = :created elsif r.name.to_s =~ /updated_/ # puts "after updated" key = :updated end if key n = r.klass.name.underscore.humanize.pluralize count = self.send(r.name).count if data[n] data[n][key] = count else data[n] = {key => count} end if count == 0 data[n][:first_created] = 'n/a' data[n][:last_updated] = 'n/a' else data[n][:first_created] = self.send(r.name).limit(1).order(created_at: :asc).first.created_at data[n][:last_updated] = self.send(r.name).limit(1).order(updated_at: :desc).first.updated_at end end end data end # rubocop:enable Metrics/MethodLength # @return [String] def generate_api_access_token self.api_access_token = Utilities::RandomToken.generate end # @return [Boolean] always true def require_password_presence @require_password_presence = true end def orcid return nil unless person person.identifiers.where(type: 'Identifier::Global::Orcid').first&.identifier end def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end # @return Array of Projects # A quick, not comprehensive check of what projects User has touched data in def data_in_projects scan = [TaxonName, Citation, CollectionObject, CollectingEvent, Image, AssertedDistribution, Role] found = [] Project.pluck(:id, :name).each do |i, name| scan.each do |k| if k.where('(updated_by_id = ? OR created_by_id = ?) AND project_id = ?', id, id, i).any? found.push name break end end end found end def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end private # @return [String] def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end # @return [Boolean] def validate_password? password.present? || password_confirmation.present? || @require_password_presence end def configure_self_created if !self.new_record? && self.creator.nil? && self.updater.nil? self.update_columns(created_by_id: self.id, updated_by_id: self.id) # !? end end end |
#remove_page_from_favorites(options = {}) ⇒ Object
TODO: move to User concern
322 323 324 325 326 327 |
# File 'app/models/user.rb', line 322 def remove_page_from_favorites( = {}) # name: nil, kind: nil, project_id: nil () new_routes = hub_favorites.dup new_routes[['project_id'].to_s][['kind']].delete(['name']) update_column(:hub_favorites, new_routes) end |
#require_password_presence ⇒ Boolean
Returns always true.
479 480 481 |
# File 'app/models/user.rb', line 479 def require_password_presence @require_password_presence = true end |
#set_remember_token ⇒ String (private)
532 533 534 |
# File 'app/models/user.rb', line 532 def set_remember_token self.remember_token = User.encrypt(User.secure_random_token) end |
#total_objects(klass) ⇒ Integer
Returns the total records of this klass created by this user.
422 423 424 |
# File 'app/models/user.rb', line 422 def total_objects(klass) # klass_name is a string, need .constantize in next line klass.where(creator: self).count end |
#total_objects2(klass_string) ⇒ Integer
428 429 430 |
# File 'app/models/user.rb', line 428 def total_objects2(klass_string) self.send("created_#{klass_string}").count #klass.where(creator:self).count end |
#transfer_housekeeping(target_user) ⇒ Object
509 510 511 512 513 514 515 516 517 518 |
# File 'app/models/user.rb', line 509 def transfer_housekeeping(target_user) models = ApplicationEnumeration.superclass_models.select { |m| m < Housekeeping::Users } User.transaction do models.each do |model| model.where(created_by_id: self.id).update_all(created_by_id: target_user.id) model.where(updated_by_id: self.id).update_all(updated_by_id: target_user.id) end end end |
#transfer_projects_membership(target_user) ⇒ Object
520 521 522 523 524 525 526 527 |
# File 'app/models/user.rb', line 520 def transfer_projects_membership(target_user) User.transaction do ProjectMember.where(user_id: self.id) .where.not(project_id: target_user.projects) .update_all(user_id: target_user.id) ProjectMember.where(user_id: self.id).delete_all end end |
#update_last_seen_at ⇒ Boolean
TODO: move to User concern
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'app/models/user.rb', line 344 def update_last_seen_at if !last_seen_at.nil? t = Time.now - last_seen_at if t > 5 a = (t < 301.0) ? (time_active + t) : (time_active || 0) update_columns(last_seen_at: Time.now, time_active: a) end else update_columns(last_seen_at: Time.now) end update_project_member_last_seen_at true end |
#update_project_member_last_seen_at ⇒ Object
TODO: we still global track at User, this is hit only when that ticker ticks
perhaps seperate for performace
363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'app/models/user.rb', line 363 def update_project_member_last_seen_at if Current.project_id && (pm = project_members.find_by(project_id: Current.project_id)) if !pm.last_seen_at.nil? t = Time.now - pm.last_seen_at if t > 5 a = (t < 301.0) ? (pm.time_active || 0) + t : (pm.time_active || 0) pm.update_columns(last_seen_at: Time.now, time_active: a) end else pm.update_columns(last_seen_at: Time.now) end end end |
#validate_favorite_options(options) ⇒ Boolean
TODO: move to User concern
332 333 334 335 336 |
# File 'app/models/user.rb', line 332 def () return false if !.select { |k, v| k.nil? || v.nil? }.empty? return false if !member_of?(['project_id']) true end |
#validate_password? ⇒ Boolean (private)
537 538 539 |
# File 'app/models/user.rb', line 537 def validate_password? password.present? || password_confirmation.present? || @require_password_presence end |
#wikidata_id ⇒ Object
488 489 490 491 |
# File 'app/models/user.rb', line 488 def wikidata_id return nil unless person person.identifiers.where(type: 'Identifier::Global::Wikidata').first&.identifier end |