2 * Server-side window stations and desktops handling
4 * Copyright (C) 2002, 2005 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/port.h"
28 #define WIN32_NO_STATUS
41 #include "wine/unicode.h"
44 static struct list winstation_list = LIST_INIT(winstation_list);
45 static struct namespace *winstation_namespace;
47 static void winstation_dump( struct object *obj, int verbose );
48 static struct object_type *winstation_get_type( struct object *obj );
49 static int winstation_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
50 static void winstation_destroy( struct object *obj );
51 static unsigned int winstation_map_access( struct object *obj, unsigned int access );
52 static void desktop_dump( struct object *obj, int verbose );
53 static struct object_type *desktop_get_type( struct object *obj );
54 static int desktop_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
55 static void desktop_destroy( struct object *obj );
56 static unsigned int desktop_map_access( struct object *obj, unsigned int access );
58 static const struct object_ops winstation_ops =
60 sizeof(struct winstation), /* size */
61 winstation_dump, /* dump */
62 winstation_get_type, /* get_type */
63 no_add_queue, /* add_queue */
64 NULL, /* remove_queue */
67 no_signal, /* signal */
68 no_get_fd, /* get_fd */
69 winstation_map_access, /* map_access */
70 default_get_sd, /* get_sd */
71 default_set_sd, /* set_sd */
72 no_lookup_name, /* lookup_name */
73 no_open_file, /* open_file */
74 winstation_close_handle, /* close_handle */
75 winstation_destroy /* destroy */
79 static const struct object_ops desktop_ops =
81 sizeof(struct desktop), /* size */
82 desktop_dump, /* dump */
83 desktop_get_type, /* get_type */
84 no_add_queue, /* add_queue */
85 NULL, /* remove_queue */
88 no_signal, /* signal */
89 no_get_fd, /* get_fd */
90 desktop_map_access, /* map_access */
91 default_get_sd, /* get_sd */
92 default_set_sd, /* set_sd */
93 no_lookup_name, /* lookup_name */
94 no_open_file, /* open_file */
95 desktop_close_handle, /* close_handle */
96 desktop_destroy /* destroy */
99 #define DESKTOP_ALL_ACCESS 0x01ff
101 /* create a winstation object */
102 static struct winstation *create_winstation( const struct unicode_str *name, unsigned int attr,
105 struct winstation *winstation;
107 if (!winstation_namespace && !(winstation_namespace = create_namespace( 7 )))
110 if (memchrW( name->str, '\\', name->len / sizeof(WCHAR) )) /* no backslash allowed in name */
112 set_error( STATUS_INVALID_PARAMETER );
116 if ((winstation = create_named_object( winstation_namespace, &winstation_ops, name, attr )))
118 if (get_error() != STATUS_OBJECT_NAME_EXISTS)
120 /* initialize it if it didn't already exist */
121 winstation->flags = flags;
122 winstation->clipboard = NULL;
123 winstation->atom_table = NULL;
124 list_add_tail( &winstation_list, &winstation->entry );
125 list_init( &winstation->desktops );
131 static void winstation_dump( struct object *obj, int verbose )
133 struct winstation *winstation = (struct winstation *)obj;
135 fprintf( stderr, "Winstation flags=%x clipboard=%p atoms=%p ",
136 winstation->flags, winstation->clipboard, winstation->atom_table );
137 dump_object_name( &winstation->obj );
138 fputc( '\n', stderr );
141 static struct object_type *winstation_get_type( struct object *obj )
143 static const WCHAR name[] = {'W','i','n','d','o','w','S','t','a','t','i','o','n'};
144 static const struct unicode_str str = { name, sizeof(name) };
145 return get_object_type( &str );
148 static int winstation_close_handle( struct object *obj, struct process *process, obj_handle_t handle )
150 return (process->winstation != handle);
153 static void winstation_destroy( struct object *obj )
155 struct winstation *winstation = (struct winstation *)obj;
157 list_remove( &winstation->entry );
158 if (winstation->clipboard) release_object( winstation->clipboard );
159 if (winstation->atom_table) release_object( winstation->atom_table );
162 static unsigned int winstation_map_access( struct object *obj, unsigned int access )
164 if (access & GENERIC_READ) access |= STANDARD_RIGHTS_READ | WINSTA_ENUMDESKTOPS | WINSTA_READATTRIBUTES |
165 WINSTA_ENUMERATE | WINSTA_READSCREEN;
166 if (access & GENERIC_WRITE) access |= STANDARD_RIGHTS_WRITE | WINSTA_ACCESSCLIPBOARD | WINSTA_CREATEDESKTOP |
167 WINSTA_WRITEATTRIBUTES;
168 if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | WINSTA_ACCESSGLOBALATOMS | WINSTA_EXITWINDOWS;
169 if (access & GENERIC_ALL) access |= STANDARD_RIGHTS_REQUIRED | WINSTA_ALL_ACCESS;
170 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
173 /* retrieve the process window station, checking the handle access rights */
174 struct winstation *get_process_winstation( struct process *process, unsigned int access )
176 return (struct winstation *)get_handle_obj( process, process->winstation,
177 access, &winstation_ops );
180 /* build the full name of a desktop object */
181 static WCHAR *build_desktop_name( const struct unicode_str *name,
182 struct winstation *winstation, struct unicode_str *res )
184 const WCHAR *winstation_name;
186 data_size_t winstation_len;
188 if (memchrW( name->str, '\\', name->len / sizeof(WCHAR) ))
190 set_error( STATUS_INVALID_PARAMETER );
194 if (!(winstation_name = get_object_name( &winstation->obj, &winstation_len )))
197 res->len = winstation_len + name->len + sizeof(WCHAR);
198 if (!(full_name = mem_alloc( res->len ))) return NULL;
199 memcpy( full_name, winstation_name, winstation_len );
200 full_name[winstation_len / sizeof(WCHAR)] = '\\';
201 memcpy( full_name + winstation_len / sizeof(WCHAR) + 1, name->str, name->len );
202 res->str = full_name;
206 /* retrieve a pointer to a desktop object */
207 struct desktop *get_desktop_obj( struct process *process, obj_handle_t handle, unsigned int access )
209 return (struct desktop *)get_handle_obj( process, handle, access, &desktop_ops );
212 /* create a desktop object */
213 static struct desktop *create_desktop( const struct unicode_str *name, unsigned int attr,
214 unsigned int flags, struct winstation *winstation )
216 struct desktop *desktop;
217 struct unicode_str full_str;
220 if (!(full_name = build_desktop_name( name, winstation, &full_str ))) return NULL;
222 if ((desktop = create_named_object( winstation_namespace, &desktop_ops, &full_str, attr )))
224 if (get_error() != STATUS_OBJECT_NAME_EXISTS)
226 /* initialize it if it didn't already exist */
227 desktop->flags = flags;
228 desktop->winstation = (struct winstation *)grab_object( winstation );
229 desktop->top_window = NULL;
230 desktop->msg_window = NULL;
231 desktop->global_hooks = NULL;
232 desktop->close_timeout = NULL;
234 list_add_tail( &winstation->desktops, &desktop->entry );
241 static void desktop_dump( struct object *obj, int verbose )
243 struct desktop *desktop = (struct desktop *)obj;
245 fprintf( stderr, "Desktop flags=%x winstation=%p top_win=%p hooks=%p ",
246 desktop->flags, desktop->winstation, desktop->top_window, desktop->global_hooks );
247 dump_object_name( &desktop->obj );
248 fputc( '\n', stderr );
251 static struct object_type *desktop_get_type( struct object *obj )
253 static const WCHAR name[] = {'D','e','s','k','t','o','p'};
254 static const struct unicode_str str = { name, sizeof(name) };
255 return get_object_type( &str );
258 static int desktop_close_handle( struct object *obj, struct process *process, obj_handle_t handle )
260 struct thread *thread;
262 /* check if the handle is currently used by the process or one of its threads */
263 if (process->desktop == handle) return 0;
264 LIST_FOR_EACH_ENTRY( thread, &process->thread_list, struct thread, proc_entry )
265 if (thread->desktop == handle) return 0;
269 static void desktop_destroy( struct object *obj )
271 struct desktop *desktop = (struct desktop *)obj;
273 if (desktop->top_window) destroy_window( desktop->top_window );
274 if (desktop->msg_window) destroy_window( desktop->msg_window );
275 if (desktop->global_hooks) release_object( desktop->global_hooks );
276 if (desktop->close_timeout) remove_timeout_user( desktop->close_timeout );
277 list_remove( &desktop->entry );
278 release_object( desktop->winstation );
281 static unsigned int desktop_map_access( struct object *obj, unsigned int access )
283 if (access & GENERIC_READ) access |= STANDARD_RIGHTS_READ | DESKTOP_READOBJECTS | DESKTOP_ENUMERATE;
284 if (access & GENERIC_WRITE) access |= STANDARD_RIGHTS_WRITE | DESKTOP_CREATEMENU | DESKTOP_CREATEWINDOW |
285 DESKTOP_HOOKCONTROL | DESKTOP_JOURNALRECORD | DESKTOP_JOURNALPLAYBACK |
286 DESKTOP_WRITEOBJECTS;
287 if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | DESKTOP_SWITCHDESKTOP;
288 if (access & GENERIC_ALL) access |= STANDARD_RIGHTS_REQUIRED | DESKTOP_ALL_ACCESS;
289 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
292 /* retrieve the thread desktop, checking the handle access rights */
293 struct desktop *get_thread_desktop( struct thread *thread, unsigned int access )
295 return get_desktop_obj( thread->process, thread->desktop, access );
298 /* set the process default desktop handle */
299 void set_process_default_desktop( struct process *process, struct desktop *desktop,
300 obj_handle_t handle )
302 struct thread *thread;
303 struct desktop *old_desktop;
305 if (process->desktop == handle) return; /* nothing to do */
307 if (!(old_desktop = get_desktop_obj( process, process->desktop, 0 ))) clear_error();
308 process->desktop = handle;
310 /* set desktop for threads that don't have one yet */
311 LIST_FOR_EACH_ENTRY( thread, &process->thread_list, struct thread, proc_entry )
312 if (!thread->desktop) thread->desktop = handle;
314 if (!process->is_system)
317 if (desktop->close_timeout)
319 remove_timeout_user( desktop->close_timeout );
320 desktop->close_timeout = NULL;
322 if (old_desktop) old_desktop->users--;
325 if (old_desktop) release_object( old_desktop );
328 /* connect a process to its window station */
329 void connect_process_winstation( struct process *process, struct thread *parent )
331 struct winstation *winstation = NULL;
332 struct desktop *desktop = NULL;
335 /* check for an inherited winstation handle (don't ask...) */
336 if ((handle = find_inherited_handle( process, &winstation_ops )))
338 winstation = (struct winstation *)get_handle_obj( process, handle, 0, &winstation_ops );
340 else if (parent && parent->process->winstation)
342 handle = duplicate_handle( parent->process, parent->process->winstation,
343 process, 0, 0, DUP_HANDLE_SAME_ACCESS );
344 winstation = (struct winstation *)get_handle_obj( process, handle, 0, &winstation_ops );
346 if (!winstation) goto done;
347 process->winstation = handle;
349 if ((handle = find_inherited_handle( process, &desktop_ops )))
351 desktop = get_desktop_obj( process, handle, 0 );
352 if (!desktop || desktop->winstation != winstation) goto done;
354 else if (parent && parent->desktop)
356 desktop = get_desktop_obj( parent->process, parent->desktop, 0 );
357 if (!desktop || desktop->winstation != winstation) goto done;
358 handle = duplicate_handle( parent->process, parent->desktop,
359 process, 0, 0, DUP_HANDLE_SAME_ACCESS );
362 if (handle) set_process_default_desktop( process, desktop, handle );
365 if (desktop) release_object( desktop );
366 if (winstation) release_object( winstation );
370 static void close_desktop_timeout( void *private )
372 struct desktop *desktop = private;
374 desktop->close_timeout = NULL;
375 unlink_named_object( &desktop->obj ); /* make sure no other process can open it */
376 close_desktop_window( desktop ); /* and signal the owner to quit */
379 /* close the desktop of a given process */
380 void close_process_desktop( struct process *process )
382 struct desktop *desktop;
384 if (process->desktop && (desktop = get_desktop_obj( process, process->desktop, 0 )))
386 assert( desktop->users > 0 );
388 /* if we have one remaining user, it has to be the manager of the desktop window */
389 if (desktop->users == 1 && get_top_window_owner( desktop ))
391 assert( !desktop->close_timeout );
392 desktop->close_timeout = add_timeout_user( -TICKS_PER_SEC, close_desktop_timeout, desktop );
394 release_object( desktop );
396 clear_error(); /* ignore errors */
399 /* close the desktop of a given thread */
400 void close_thread_desktop( struct thread *thread )
402 obj_handle_t handle = thread->desktop;
405 if (handle) close_handle( thread->process, handle );
406 clear_error(); /* ignore errors */
409 /* set the reply data from the object name */
410 static void set_reply_data_obj_name( struct object *obj )
413 const WCHAR *ptr, *name = get_object_name( obj, &len );
415 /* if there is a backslash return the part of the name after it */
416 if (name && (ptr = memchrW( name, '\\', len/sizeof(WCHAR) )))
418 len -= (ptr + 1 - name) * sizeof(WCHAR);
421 if (name) set_reply_data( name, min( len, get_reply_max_size() ));
424 /* create a window station */
425 DECL_HANDLER(create_winstation)
427 struct winstation *winstation;
428 struct unicode_str name;
431 get_req_unicode_str( &name );
432 if ((winstation = create_winstation( &name, req->attributes, req->flags )))
434 reply->handle = alloc_handle( current->process, winstation, req->access, req->attributes );
435 release_object( winstation );
439 /* open a handle to a window station */
440 DECL_HANDLER(open_winstation)
442 struct unicode_str name;
444 get_req_unicode_str( &name );
445 if (winstation_namespace)
446 reply->handle = open_object( winstation_namespace, &name, &winstation_ops, req->access,
449 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
453 /* close a window station */
454 DECL_HANDLER(close_winstation)
456 struct winstation *winstation;
458 if ((winstation = (struct winstation *)get_handle_obj( current->process, req->handle,
459 0, &winstation_ops )))
461 if (!close_handle( current->process, req->handle )) set_error( STATUS_ACCESS_DENIED );
462 release_object( winstation );
467 /* get the process current window station */
468 DECL_HANDLER(get_process_winstation)
470 reply->handle = current->process->winstation;
474 /* set the process current window station */
475 DECL_HANDLER(set_process_winstation)
477 struct winstation *winstation;
479 if ((winstation = (struct winstation *)get_handle_obj( current->process, req->handle,
480 0, &winstation_ops )))
482 /* FIXME: should we close the old one? */
483 current->process->winstation = req->handle;
484 release_object( winstation );
488 /* create a desktop */
489 DECL_HANDLER(create_desktop)
491 struct desktop *desktop;
492 struct winstation *winstation;
493 struct unicode_str name;
496 get_req_unicode_str( &name );
497 if ((winstation = get_process_winstation( current->process, WINSTA_CREATEDESKTOP )))
499 if ((desktop = create_desktop( &name, req->attributes, req->flags, winstation )))
501 reply->handle = alloc_handle( current->process, desktop, req->access, req->attributes );
502 release_object( desktop );
504 release_object( winstation );
508 /* open a handle to a desktop */
509 DECL_HANDLER(open_desktop)
511 struct winstation *winstation;
512 struct unicode_str name;
514 get_req_unicode_str( &name );
516 /* FIXME: check access rights */
518 winstation = get_process_winstation( current->process, 0 );
520 winstation = (struct winstation *)get_handle_obj( current->process, req->winsta, 0, &winstation_ops );
524 struct unicode_str full_str;
527 if ((full_name = build_desktop_name( &name, winstation, &full_str )))
529 reply->handle = open_object( winstation_namespace, &full_str, &desktop_ops, req->access,
533 release_object( winstation );
538 /* close a desktop */
539 DECL_HANDLER(close_desktop)
541 struct desktop *desktop;
543 /* make sure it is a desktop handle */
544 if ((desktop = (struct desktop *)get_handle_obj( current->process, req->handle,
547 if (!close_handle( current->process, req->handle )) set_error( STATUS_DEVICE_BUSY );
548 release_object( desktop );
553 /* get the thread current desktop */
554 DECL_HANDLER(get_thread_desktop)
556 struct thread *thread;
558 if (!(thread = get_thread_from_id( req->tid ))) return;
559 reply->handle = thread->desktop;
560 release_object( thread );
564 /* set the thread current desktop */
565 DECL_HANDLER(set_thread_desktop)
567 struct desktop *old_desktop, *new_desktop;
568 struct winstation *winstation;
570 if (!(winstation = get_process_winstation( current->process, 0 /* FIXME: access rights? */ )))
573 if (!(new_desktop = get_desktop_obj( current->process, req->handle, 0 )))
575 release_object( winstation );
578 if (new_desktop->winstation != winstation)
580 set_error( STATUS_ACCESS_DENIED );
581 release_object( new_desktop );
582 release_object( winstation );
586 /* check if we are changing to a new desktop */
588 if (!(old_desktop = get_desktop_obj( current->process, current->desktop, 0)))
589 clear_error(); /* ignore error */
591 /* when changing desktop, we can't have any users on the current one */
592 if (old_desktop != new_desktop && current->desktop_users > 0)
593 set_error( STATUS_DEVICE_BUSY );
595 current->desktop = req->handle; /* FIXME: should we close the old one? */
597 if (!current->process->desktop)
598 set_process_default_desktop( current->process, new_desktop, req->handle );
600 if (old_desktop != new_desktop && current->queue) detach_thread_input( current );
602 if (old_desktop) release_object( old_desktop );
603 release_object( new_desktop );
604 release_object( winstation );
608 /* get/set information about a user object (window station or desktop) */
609 DECL_HANDLER(set_user_object_info)
613 if (!(obj = get_handle_obj( current->process, req->handle, 0, NULL ))) return;
615 if (obj->ops == &desktop_ops)
617 struct desktop *desktop = (struct desktop *)obj;
618 reply->is_desktop = 1;
619 reply->old_obj_flags = desktop->flags;
620 if (req->flags & SET_USER_OBJECT_FLAGS) desktop->flags = req->obj_flags;
622 else if (obj->ops == &winstation_ops)
624 struct winstation *winstation = (struct winstation *)obj;
625 reply->is_desktop = 0;
626 reply->old_obj_flags = winstation->flags;
627 if (req->flags & SET_USER_OBJECT_FLAGS) winstation->flags = req->obj_flags;
631 set_error( STATUS_OBJECT_TYPE_MISMATCH );
632 release_object( obj );
635 if (get_reply_max_size()) set_reply_data_obj_name( obj );
636 release_object( obj );
640 /* enumerate window stations */
641 DECL_HANDLER(enum_winstation)
643 unsigned int index = 0;
644 struct winstation *winsta;
646 LIST_FOR_EACH_ENTRY( winsta, &winstation_list, struct winstation, entry )
648 unsigned int access = WINSTA_ENUMERATE;
649 if (req->index > index++) continue;
650 if (!check_object_access( &winsta->obj, &access )) continue;
651 set_reply_data_obj_name( &winsta->obj );
656 set_error( STATUS_NO_MORE_ENTRIES );
660 /* enumerate desktops */
661 DECL_HANDLER(enum_desktop)
663 struct winstation *winstation;
664 struct desktop *desktop;
665 unsigned int index = 0;
667 if (!(winstation = (struct winstation *)get_handle_obj( current->process, req->winstation,
668 WINSTA_ENUMDESKTOPS, &winstation_ops )))
671 LIST_FOR_EACH_ENTRY( desktop, &winstation->desktops, struct desktop, entry )
673 unsigned int access = DESKTOP_ENUMERATE;
674 if (req->index > index++) continue;
675 if (!desktop->obj.name) continue;
676 if (!check_object_access( &desktop->obj, &access )) continue;
677 set_reply_data_obj_name( &desktop->obj );
678 release_object( winstation );
684 release_object( winstation );
685 set_error( STATUS_NO_MORE_ENTRIES );